openapi: 3.0.1 info: title: VBASoftware description: APIs for VBASoftware version: v1 servers: - url: https://vbapi.vbasoftware.com/vbasoftware description: VBAPI VBASoftware paths: /accounting-claim-refund: post: tags: - Accounting - Adv. Accounting summary: Claim Refund description: Process a Claim Refund creating the necessary Backout and Reentry claims and adding Claim Reference values. operationId: ClaimRefund parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingProcessClaimRefund' text/json: schema: $ref: '#/components/schemas/FundingProcessClaimRefund' application/*+json: schema: $ref: '#/components/schemas/FundingProcessClaimRefund' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /accounting-fund-request: post: tags: - Accounting - Adv. Accounting summary: Claim Account Funding description: Submit a list of Payor/Account information to be funded based on configured parameters. Returns whether there are invalid entries in your list that were skipped during processing. operationId: AccountingFundRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FUNDACCOUNTBALANCELIST' text/json: schema: type: array items: $ref: '#/components/schemas/FUNDACCOUNTBALANCELIST' application/*+json: schema: type: array items: $ref: '#/components/schemas/FUNDACCOUNTBALANCELIST' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BooleanVBAResponse' application/json: schema: $ref: '#/components/schemas/BooleanVBAResponse' text/json: schema: $ref: '#/components/schemas/BooleanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/claim-batches/{batchNumber}/claims/{batchClaim}/adjudicate': post: tags: - Claim Adjudication summary: Adjudicate Single Claim description: 'Adjudicates a single claim and waits for the response. If a value is provided for the optional parameter requestingUser, the value will be included in the logs as the user initiating the action.' operationId: AdjudicateClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: requestingUser in: query description: Requesting User schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatch_ClaimBatchDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatch_ClaimBatchDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatch_ClaimBatchDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/claim-batches/{batchNumber}/claims/{batchClaim}/adjudicate-no-response': post: tags: - Claim Adjudication summary: Adjudicate Single Claim without response description: 'Adjudicates a single claim and does not include a response body of the resulting Claim details. This makes for faster request. If a value is provided for the optional parameter requestingUser, the value will be included in the logs as the user initiating the action.' operationId: AdjudicateClaimNoResponse parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: requestingUser in: query description: Requesting User schema: type: string responses: '202': description: Accepted '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/claim-queues/{claimQueueKey}/adjudicate': post: tags: - Claim Adjudication summary: Adjudicate Entire Queue description: Adjudicates all Claims within a Claim Queue. This is a Fire and Forget. Results of the adjudication will start to be visible shortly after calling this endpoint. operationId: AdjudicateClaimQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: Claim Queue Key required: true schema: type: integer format: int32 responses: '202': description: Accepted '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/claim-batches/{batchNumber}/claims/{batchClaim}/process': post: tags: - Claim Adjudication summary: Process Single Claim description: 'Process a single claim and waits for the response. If a value is provided for the optional parameter requestingUser, the value will be included in the logs as the user initiating the action.' operationId: ProcessClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: requestingUser in: query description: Requesting User schema: type: string responses: '200': description: Claim processed successfully. '202': description: 'Claim was accepted and processed, but did not move to the Claim table due to invalid data or business rule violations.' content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/claim-queues/{claimQueueKey}/process': post: tags: - Claim Adjudication summary: Process Entire Queue description: Process all Claims within a Claim Queue. This is a Fire and Forget. Results of the adjudication will start to be visible shortly after calling this endpoint. operationId: ProcessClaimQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: Claim Queue Key required: true schema: type: integer format: int32 responses: '202': description: Accepted '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /vba-interface-directions: get: tags: - VBAInterfaces summary: List VBA Interface Directions description: List VBA Interface Directions operationId: ListVBAInterfaceDirections parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /admission-type-places: post: tags: - Admission Type Places summary: Create AdmissionTypePlace description: Creates a new AdmissionTypePlace operationId: CreateAdmissionTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AdmissionTypePlace' text/json: schema: $ref: '#/components/schemas/AdmissionTypePlace' application/*+json: schema: $ref: '#/components/schemas/AdmissionTypePlace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AdmissionTypePlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/AdmissionTypePlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/AdmissionTypePlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Admission Type Places summary: List AdmissionTypePlace description: Lists all AdmissionTypePlace operationId: ListAdmissionTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AdmissionTypePlaceListVBAResponse' application/json: schema: $ref: '#/components/schemas/AdmissionTypePlaceListVBAResponse' text/json: schema: $ref: '#/components/schemas/AdmissionTypePlaceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/admission-type-places/{admissionType}/{placeOfService}': get: tags: - Admission Type Places summary: Get AdmissionTypePlace description: Gets AdmissionTypePlace operationId: GetAdmissionTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: admissionType in: path description: Admission Type required: true schema: type: string - name: placeOfService in: path description: Place Of Service required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AdmissionTypePlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/AdmissionTypePlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/AdmissionTypePlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Admission Type Places summary: Update AdmissionTypePlace description: Updates a specific AdmissionTypePlace. operationId: UpdateAdmissionTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: admissionType in: path description: Admission Type required: true schema: type: string - name: placeOfService in: path description: Place Of Service required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AdmissionTypePlace' text/json: schema: $ref: '#/components/schemas/AdmissionTypePlace' application/*+json: schema: $ref: '#/components/schemas/AdmissionTypePlace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AdmissionTypePlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/AdmissionTypePlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/AdmissionTypePlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Admission Type Places summary: Delete AdmissionTypePlace description: Deletes an AdmissionTypePlace operationId: DeleteAdmissionTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: admissionType in: path description: Admission Type required: true schema: type: string - name: placeOfService in: path description: Place Of Service required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /admission-type-places-batch: put: tags: - Admission Type Places summary: Create or Update Batch AdmissionTypePlace description: 'Create or Update multiple AdmissionTypePlace at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchAdmissionTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AdmissionTypePlace' text/json: schema: type: array items: $ref: '#/components/schemas/AdmissionTypePlace' application/*+json: schema: type: array items: $ref: '#/components/schemas/AdmissionTypePlace' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /amount-details: get: tags: - Amount Details summary: List AmountDetails description: Lists all AmountDetails operationId: ListAmountDetails parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AmountDetailsListVBAResponse' application/json: schema: $ref: '#/components/schemas/AmountDetailsListVBAResponse' text/json: schema: $ref: '#/components/schemas/AmountDetailsListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/amount-details/{key}': get: tags: - Amount Details summary: Get AmountDetails description: Gets AmountDetails operationId: GetAmountDetails parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: key in: path description: Key required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AmountDetailsVBAResponse' application/json: schema: $ref: '#/components/schemas/AmountDetailsVBAResponse' text/json: schema: $ref: '#/components/schemas/AmountDetailsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /apc-codes: post: tags: - APC Codes summary: Create APCCodes description: Creates a new APCCodes operationId: CreateAPCCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/APCCodes' text/json: schema: $ref: '#/components/schemas/APCCodes' application/*+json: schema: $ref: '#/components/schemas/APCCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/APCCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/APCCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/APCCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - APC Codes summary: List APCCodes description: Lists all APCCodes operationId: ListAPCCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/APCCodesListVBAResponse' application/json: schema: $ref: '#/components/schemas/APCCodesListVBAResponse' text/json: schema: $ref: '#/components/schemas/APCCodesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/apc-codes/{apcCode}': get: tags: - APC Codes summary: Get APCCodes description: Gets APCCodes operationId: GetAPCCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: apcCode in: path description: APC Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/APCCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/APCCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/APCCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - APC Codes summary: Update APCCodes description: Updates a specific APCCodes. operationId: UpdateAPCCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: apcCode in: path description: APC Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/APCCodes' text/json: schema: $ref: '#/components/schemas/APCCodes' application/*+json: schema: $ref: '#/components/schemas/APCCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/APCCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/APCCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/APCCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - APC Codes summary: Delete APCCodes description: Deletes an APCCodes operationId: DeleteAPCCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: apcCode in: path description: APC Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /apc-codes-batch: put: tags: - APC Codes summary: Create or Update Batch APCCodes description: 'Create or Update multiple APCCodes at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchAPCCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/APCCodes' text/json: schema: type: array items: $ref: '#/components/schemas/APCCodes' application/*+json: schema: type: array items: $ref: '#/components/schemas/APCCodes' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /apc-schedules: post: tags: - APC Schedules summary: Create APCSchedule description: Creates a new APCSchedule operationId: CreateAPCSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/APCSchedule' text/json: schema: $ref: '#/components/schemas/APCSchedule' application/*+json: schema: $ref: '#/components/schemas/APCSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/APCScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/APCScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/APCScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - APC Schedules summary: List APCSchedule description: Lists all APCSchedule operationId: ListAPCSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/APCScheduleListVBAResponse' application/json: schema: $ref: '#/components/schemas/APCScheduleListVBAResponse' text/json: schema: $ref: '#/components/schemas/APCScheduleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/apc-schedules/{aPCSchedule}': get: tags: - APC Schedules summary: Get APCSchedule description: Gets APCSchedule operationId: GetAPCSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: aPCSchedule in: path description: APC Schedule required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/APCScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/APCScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/APCScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - APC Schedules summary: Update APCSchedule description: Updates a specific APCSchedule. operationId: UpdateAPCSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: aPCSchedule in: path description: APC Schedule required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/APCSchedule' text/json: schema: $ref: '#/components/schemas/APCSchedule' application/*+json: schema: $ref: '#/components/schemas/APCSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/APCScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/APCScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/APCScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - APC Schedules summary: Delete APCSchedule description: Deletes an APCSchedule operationId: DeleteAPCSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: aPCSchedule in: path description: APC Schedule required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /apc-schedules-batch: put: tags: - APC Schedules summary: Create or Update Batch APCSchedule description: 'Create or Update multiple APCSchedule at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchAPCSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/APCSchedule' text/json: schema: type: array items: $ref: '#/components/schemas/APCSchedule' application/*+json: schema: type: array items: $ref: '#/components/schemas/APCSchedule' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /apc-weights: post: tags: - APC Weights summary: Create APCWeight description: Creates a new APCWeight operationId: CreateAPCWeight parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/APCWeight' text/json: schema: $ref: '#/components/schemas/APCWeight' application/*+json: schema: $ref: '#/components/schemas/APCWeight' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/APCWeightVBAResponse' application/json: schema: $ref: '#/components/schemas/APCWeightVBAResponse' text/json: schema: $ref: '#/components/schemas/APCWeightVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - APC Weights summary: List APCWeight description: Lists all APCWeight for the given apcSchedule and apcCode operationId: ListAPCWeight parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: apcSchedule in: query description: APC Schedule schema: type: string - name: apcCode in: query description: APC Code schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/APCWeightListVBAResponse' application/json: schema: $ref: '#/components/schemas/APCWeightListVBAResponse' text/json: schema: $ref: '#/components/schemas/APCWeightListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/apc-weights/{apcSchedule}/{apcCode}/{effectiveDate}': get: tags: - APC Weights summary: Get APCWeight description: Gets APCWeight operationId: GetAPCWeight parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: apcSchedule in: path description: APC Schedule required: true schema: type: string - name: apcCode in: path description: APC Code required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/APCWeightVBAResponse' application/json: schema: $ref: '#/components/schemas/APCWeightVBAResponse' text/json: schema: $ref: '#/components/schemas/APCWeightVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - APC Weights summary: Update APCWeight description: Updates a specific APCWeight. operationId: UpdateAPCWeight parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: apcSchedule in: path description: APC Schedule required: true schema: type: string - name: apcCode in: path description: APC Code required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/APCWeight' text/json: schema: $ref: '#/components/schemas/APCWeight' application/*+json: schema: $ref: '#/components/schemas/APCWeight' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/APCWeightVBAResponse' application/json: schema: $ref: '#/components/schemas/APCWeightVBAResponse' text/json: schema: $ref: '#/components/schemas/APCWeightVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - APC Weights summary: Delete APCWeight description: Deletes an APCWeight operationId: DeleteAPCWeight parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: apcSchedule in: path description: APC Schedule required: true schema: type: string - name: apcCode in: path description: APC Code required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /apc-weights-batch: put: tags: - APC Weights summary: Create or Update Batch APCWeight description: 'Create or Update multiple APCWeight at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchAPCWeight parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/APCWeight' text/json: schema: type: array items: $ref: '#/components/schemas/APCWeight' application/*+json: schema: type: array items: $ref: '#/components/schemas/APCWeight' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /armor-code-ex-codes: post: tags: - Armor Code ExCode summary: Create ArmorCodeExCode description: Creates a new ArmorCodeExCode operationId: CreateArmorCodeExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ArmorCodeExCode' text/json: schema: $ref: '#/components/schemas/ArmorCodeExCode' application/*+json: schema: $ref: '#/components/schemas/ArmorCodeExCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ArmorCodeExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ArmorCodeExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ArmorCodeExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Armor Code ExCode summary: List ArmorCodeExCode description: Lists all ArmorCodeExCode operationId: ListArmorCodeExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ArmorCodeExCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ArmorCodeExCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ArmorCodeExCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/armor-code-ex-codes/{ArmorCodeExCode_Key}': get: tags: - Armor Code ExCode summary: Get ArmorCodeExCode description: Gets ArmorCodeExCode operationId: GetArmorCodeExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ArmorCodeExCode_Key in: path description: ArmorCodeExCode Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ArmorCodeExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ArmorCodeExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ArmorCodeExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Armor Code ExCode summary: Update ArmorCodeExCode description: Updates a specific ArmorCodeExCode. operationId: UpdateArmorCodeExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ArmorCodeExCode_Key in: path description: ArmorCodeExCode Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ArmorCodeExCode' text/json: schema: $ref: '#/components/schemas/ArmorCodeExCode' application/*+json: schema: $ref: '#/components/schemas/ArmorCodeExCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ArmorCodeExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ArmorCodeExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ArmorCodeExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Armor Code ExCode summary: Delete ArmorCodeExCode description: Deletes an ArmorCodeExCode operationId: DeleteArmorCodeExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ArmorCodeExCode_Key in: path description: ArmorCodeExCode Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /armor-code-ex-codes-batch: put: tags: - Armor Code ExCode summary: Create or Update Batch ArmorCodeExCode description: 'Create or Update multiple ArmorCodeExCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchArmorCodeExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ArmorCodeExCode' text/json: schema: type: array items: $ref: '#/components/schemas/ArmorCodeExCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/ArmorCodeExCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auths: post: tags: - Auth summary: Create Auth description: Creates a new Auth and returns the generated Auth. operationId: CreateAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Auth' text/json: schema: $ref: '#/components/schemas/Auth' application/*+json: schema: $ref: '#/components/schemas/Auth' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth summary: Create or Update Auth Batch description: Creates or Updates Multiple Auths operationId: CreateOrUpdateAuthBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Auth' text/json: schema: type: array items: $ref: '#/components/schemas/Auth' application/*+json: schema: type: array items: $ref: '#/components/schemas/Auth' required: true responses: '207': description: Multicode response content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auths/{authNumber}': get: tags: - Auth summary: Get Auth description: Gets a specific Auth. operationId: GetAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth Number required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth summary: Update Auth description: Updates a specific Auth and returns the updated Auth after changes have been applied. operationId: UpdateAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth Number required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Auth' text/json: schema: $ref: '#/components/schemas/Auth' application/*+json: schema: $ref: '#/components/schemas/Auth' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth summary: Delete Auth description: Deletes an Auth. operationId: DeleteAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth Number required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auths-vba/{authNumber}': get: tags: - Auth summary: Get VBA Auth description: Gets a specific Auth with VBASoftware custom fields included. operationId: GetVBAAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth Number required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_AuthVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_AuthVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_AuthVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auths/{authNumber}/adjust': post: tags: - Auth - Adv. Auth summary: Auth Adjustment description: Performs an Auth Adjustment using the values and flags specified operationId: AuthAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth Number required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthAdjustment' text/json: schema: $ref: '#/components/schemas/AuthAdjustment' application/*+json: schema: $ref: '#/components/schemas/AuthAdjustment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/auths/{authNumber}/process-status/{newAuthCode}': post: tags: - Auth - Adv. Auth summary: Process a change in Auth Status description: Initiates an Auth Status change. operationId: AuthProcessStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: the Entity required: true schema: type: string - name: newAuthCode in: path description: New Auth Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /auth-actions: get: tags: - Auth Action summary: List AuthActions description: List all AuthActions operationId: ListAuthAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthActionListVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthActionListVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthActionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-codes: post: tags: - Auth Code summary: Create AuthCode description: Creates a new AuthCode. operationId: CreateAuthCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthCode' text/json: schema: $ref: '#/components/schemas/AuthCode' application/*+json: schema: $ref: '#/components/schemas/AuthCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auth-codes/{authCode}': get: tags: - Auth Code summary: Get AuthCode description: Gets AuthCode operationId: GetAuthCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authCode in: path description: Auth Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth Code summary: Update AuthCode description: Updates a specific AuthCode. operationId: UpdateAuthCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authCode in: path description: Auth Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthCode' text/json: schema: $ref: '#/components/schemas/AuthCode' application/*+json: schema: $ref: '#/components/schemas/AuthCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth Code summary: Delete AuthCode description: Deletes an AuthCode operationId: DeleteAuthCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authCode in: path description: Auth Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-codes-batch: put: tags: - Auth Code summary: Update Batch AuthCode description: Updates a multiple AuthCode. operationId: UpdateBatchAuthCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthCode' text/json: schema: type: array items: $ref: '#/components/schemas/AuthCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/AuthCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auths/{authNumber}/diagnostic-codes': post: tags: - Auth Diagnostic Codes summary: Create Auth Diagnostic Code description: Creates a new Diagnostic Code. operationId: CreateAuthDiagCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth Number required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthDiagCodes' text/json: schema: $ref: '#/components/schemas/AuthDiagCodes' application/*+json: schema: $ref: '#/components/schemas/AuthDiagCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthDiagCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthDiagCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthDiagCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Auth Diagnostic Codes summary: List Diagnostic Codes for Auth description: List Diagnostic Codes for a specific Auth operationId: GetAuthDiagCodeList parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth Number required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthDiagCodesListVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthDiagCodesListVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthDiagCodesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auths/{authNumber}/diagnostic-codes/{diagnosticCode}': get: tags: - Auth Diagnostic Codes summary: List Diagnostic Codes with Value description: List Diagnostic Codes with a specific Diagnostic Code value. operationId: GetDiagCodeList parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth Number required: true schema: type: string - name: diagnosticCode in: path description: Diagnostic Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthDiagCodesListVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthDiagCodesListVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthDiagCodesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auths/{authNumber}/diagnostic-codes/{diagnosticCode}/diagnostic-code-types/{diagnosticCodeType}': get: tags: - Auth Diagnostic Codes summary: Get Diagnostic Code description: Gets a specific Diagnostic Code operationId: GetDiagCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth Number required: true schema: type: string - name: diagnosticCode in: path description: Diagnostic Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthDiagCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthDiagCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthDiagCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth Diagnostic Codes summary: Update Diagnostic Code description: Updates a specific Diagnostic Code. operationId: UpdateAuthDiagCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth number required: true schema: type: string - name: diagnosticCode in: path description: Diagnostic Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthDiagCodes' text/json: schema: $ref: '#/components/schemas/AuthDiagCodes' application/*+json: schema: $ref: '#/components/schemas/AuthDiagCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthDiagCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthDiagCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthDiagCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth Diagnostic Codes summary: Delete Diagnostic Code description: Deletes a specific Diagnostic Code. operationId: DeleteAuthDiagCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth Number required: true schema: type: string - name: diagnosticCode in: path description: Diagnostic Code to delete required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auths/{authNumber}/diagnostic-codes-batch': put: tags: - Auth Diagnostic Codes summary: Update Diagnostic Code Batch description: Updates multiple Diagnostic Code operationId: UpdateAuthDiagCodeBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth number required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthDiagCodes' text/json: schema: type: array items: $ref: '#/components/schemas/AuthDiagCodes' application/*+json: schema: type: array items: $ref: '#/components/schemas/AuthDiagCodes' required: true responses: '207': description: Multicode response content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /user-authentication: post: tags: - User - User Account summary: User Authentication description: Starts User Authentication operationId: UserAuthentication parameters: - name: vbasoftware-client-id in: header description: Client ID required: true schema: type: string - name: vbasoftware-client-code in: header description: Client Code required: true schema: type: string - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserAuthenticationResponseVBAResponse' application/json: schema: $ref: '#/components/schemas/UserAuthenticationResponseVBAResponse' text/json: schema: $ref: '#/components/schemas/UserAuthenticationResponseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] basicAuth: [ ] /user-refresh-tokens: post: tags: - User - User Account summary: Refresh User Tokens description: Uses the Refresh Token to obtain new JWT tokens to extend the user's session. operationId: RefreshUserTokens parameters: - name: vbasoftware-client-id in: header description: Client ID required: true schema: type: string - name: vbasoftware-client-code in: header description: Client Code required: true schema: type: string - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: expired-id-token in: header description: Expired Id Token required: true schema: type: string - name: refresh-token in: header description: Refresh Token required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserAuthenticationResponseVBAResponse' application/json: schema: $ref: '#/components/schemas/UserAuthenticationResponseVBAResponse' text/json: schema: $ref: '#/components/schemas/UserAuthenticationResponseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] /change-temporary-password: post: tags: - User - User Account summary: Change Temporary Password description: Changes a User's temporary password. operationId: UserChangeTempPassword parameters: - name: vbasoftware-client-id in: header description: Client ID required: true schema: type: string - name: vbasoftware-client-code in: header description: Client Code required: true schema: type: string - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserChangeTempPasswordRequest' text/json: schema: $ref: '#/components/schemas/UserChangeTempPasswordRequest' application/*+json: schema: $ref: '#/components/schemas/UserChangeTempPasswordRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserChangeTempPasswordResponseVBAResponse' application/json: schema: $ref: '#/components/schemas/UserChangeTempPasswordResponseVBAResponse' text/json: schema: $ref: '#/components/schemas/UserChangeTempPasswordResponseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] /forgot-password: post: tags: - User - User Account summary: Forgot Password description: Begin password recovery flow. Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. operationId: ForgotPassword parameters: - name: vbasoftware-client-id in: header description: Client ID required: true schema: type: string - name: vbasoftware-client-code in: header description: Client Code required: true schema: type: string - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserForgotPasswordRequest' text/json: schema: $ref: '#/components/schemas/UserForgotPasswordRequest' application/*+json: schema: $ref: '#/components/schemas/UserForgotPasswordRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserForgotPasswordResponseVBAResponse' application/json: schema: $ref: '#/components/schemas/UserForgotPasswordResponseVBAResponse' text/json: schema: $ref: '#/components/schemas/UserForgotPasswordResponseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] /confirm-forgot-password: post: tags: - User - User Account summary: Confirm Forgot Password description: Allows a user to enter a confirmation code to reset a forgotten password. operationId: ConfirmForgotPassword parameters: - name: vbasoftware-client-id in: header description: Client ID required: true schema: type: string - name: vbasoftware-client-code in: header description: Client Code required: true schema: type: string - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserConfirmForgotPasswordRequest' text/json: schema: $ref: '#/components/schemas/UserConfirmForgotPasswordRequest' application/*+json: schema: $ref: '#/components/schemas/UserConfirmForgotPasswordRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserConfirmForgotPasswordResponseVBAResponse' application/json: schema: $ref: '#/components/schemas/UserConfirmForgotPasswordResponseVBAResponse' text/json: schema: $ref: '#/components/schemas/UserConfirmForgotPasswordResponseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] '/users/{userID}/change-password': post: tags: - User - User Account summary: User Change Password description: User requests to change their password. operationId: UserChangePassword parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserResetPasswordRequest' text/json: schema: $ref: '#/components/schemas/UserResetPasswordRequest' application/*+json: schema: $ref: '#/components/schemas/UserResetPasswordRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/admin-reset-password': post: tags: - User - User Account summary: Admin Reset User Password description: 'Admin request to reset a User''s password. When an Administrator calls this API, the User''s current password is invalidated and must be changed. If a user tries to sign in after the API is called, the User will get a `PasswordResetRequired` message back and should use the `forgot password` flow. In addition, if a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.' operationId: UserResetPassword parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/admin-disable': post: tags: - User - User Account summary: Admin Disable User description: Admin request to disable a User. operationId: AdminDisableUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/admin-enable': post: tags: - User - User Account summary: Admin Enable User description: Admin request to enable a User. operationId: AdminEnableUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/resend-confirmation-code': post: tags: - User - User Account summary: Admin Resend Confirmation Code description: Resends a User a confirmation code. operationId: AdminResendConfirmationCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/resend-welcome-message': post: tags: - User - User Account summary: Admin Resend Welcome Message description: Resends the invitation message to a user that already exists and resets the expiration on the user's sign-up window. operationId: AdminResendWelcomeMesasge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/lock': put: tags: - User Account summary: Lock User Account description: Locks a specific user account to prevent access operationId: LockUserAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UsersVBAResponse' application/json: schema: $ref: '#/components/schemas/UsersVBAResponse' text/json: schema: $ref: '#/components/schemas/UsersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/unlock': put: tags: - User Account summary: Unlock User Account description: Unlocks a specific user account to grant access operationId: UnlockUserAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UsersVBAResponse' application/json: schema: $ref: '#/components/schemas/UsersVBAResponse' text/json: schema: $ref: '#/components/schemas/UsersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auths/{authNumber}/procedure-codes': post: tags: - Auth Procedure Codes summary: Create Procedure Code description: Creates a new Procedure Code. operationId: CreateAuthProcCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth Number required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthProcCodes' text/json: schema: $ref: '#/components/schemas/AuthProcCodes' application/*+json: schema: $ref: '#/components/schemas/AuthProcCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthProcCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthProcCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthProcCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Auth Procedure Codes summary: List Procedure Codes for Auth description: Gets all Procedure Codes for a specific Auth operationId: ListAuthProcCodeByAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth number required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthProcCodesListVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthProcCodesListVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthProcCodesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auths/{authNumber}/procedure-codes-batch': post: tags: - Auth Procedure Codes summary: Create Procedure Code Batch description: Creates multiple Procedure Codes operationId: CreateAuthProcCodeBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth number required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthProcCodes' text/json: schema: type: array items: $ref: '#/components/schemas/AuthProcCodes' application/*+json: schema: type: array items: $ref: '#/components/schemas/AuthProcCodes' required: true responses: '207': description: Multicode response content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth Procedure Codes summary: Delete Procedure Code Batch description: Deletes multiple Procedure Codes operationId: DeleteAuthProcCodeBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth number required: true schema: type: string requestBody: content: application/json: schema: type: array items: type: integer format: int32 text/json: schema: type: array items: type: integer format: int32 application/*+json: schema: type: array items: type: integer format: int32 required: true responses: '207': description: Multicode response content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auths/{authNumber}/procedure-codes/{procedureCodeKey}': get: tags: - Auth Procedure Codes summary: Get Procedure Code description: Gets a specific Procedure Code operationId: GetAuthProcCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth number required: true schema: type: string - name: procedureCodeKey in: path description: Procedure Code Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthProcCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthProcCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthProcCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth Procedure Codes summary: Update Procedure Code description: Updates a specific Procedure Code. operationId: UpdateAuthProcCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth number required: true schema: type: string - name: procedureCodeKey in: path description: Procedure Code Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthProcCodes' text/json: schema: $ref: '#/components/schemas/AuthProcCodes' application/*+json: schema: $ref: '#/components/schemas/AuthProcCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthProcCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthProcCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthProcCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth Procedure Codes summary: Delete Procedure Code description: Deletes a specific Procedure Code. operationId: DeleteAuthProcCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: path description: Auth number required: true schema: type: string - name: procedureCodeKey in: path description: Procedure Code Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auths/{originalAuthNumber}/references': post: tags: - Auth Reference summary: Create AuthReference description: Creates a new AuthReference from an existing Auth operationId: CreateAuthReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: originalAuthNumber in: path description: Original Auth Number required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReference' text/json: schema: $ref: '#/components/schemas/AuthReference' application/*+json: schema: $ref: '#/components/schemas/AuthReference' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReferenceVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReferenceVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReferenceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Auth Reference summary: List AuthReferences description: Lists all AuthReference for an existing Auth operationId: ListAuthReferenceForAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: originalAuthNumber in: path description: Original Auth Number required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthListVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthListVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auths/{originalAuthNumber}/references/{referencedAuthNumber}': get: tags: - Auth Reference summary: Get AuthReference description: Gets AuthReference operationId: GetAuthReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: originalAuthNumber in: path description: Original Auth Number required: true schema: type: string - name: referencedAuthNumber in: path description: Referenced Auth Number required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReferenceVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReferenceVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReferenceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth Reference summary: Update AuthReference description: Updates a specific AuthReference. operationId: UpdateAuthReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: originalAuthNumber in: path description: Original Auth Number required: true schema: type: string - name: referencedAuthNumber in: path description: Referenced Auth Number required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReference' text/json: schema: $ref: '#/components/schemas/AuthReference' application/*+json: schema: $ref: '#/components/schemas/AuthReference' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReferenceVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReferenceVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReferenceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth Reference summary: Delete AuthReference description: Deletes an AuthReference operationId: DeleteAuthReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: originalAuthNumber in: path description: Original Auth Number required: true schema: type: string - name: referencedAuthNumber in: path description: Referenced Auth Number required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auths/{originalAuthNumber}/references-batch': put: tags: - Auth Reference summary: Update Batch AuthReference description: Updates a multiple AuthReference. operationId: UpdateBatchAuthReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: originalAuthNumber in: path description: Original Auth Number required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthReference' text/json: schema: type: array items: $ref: '#/components/schemas/AuthReference' application/*+json: schema: type: array items: $ref: '#/components/schemas/AuthReference' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-reviews: post: tags: - Auth Review summary: Create AuthReview description: Creates a new AuthReview. operationId: CreateAuthReview parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReview' text/json: schema: $ref: '#/components/schemas/AuthReview' application/*+json: schema: $ref: '#/components/schemas/AuthReview' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Auth Review summary: List AuthReviews description: Lists all AuthReviews operationId: ListAuthReviews parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authNumber in: query description: Auth Number schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewListVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewListVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auth-reviews/{authReviewKey}': get: tags: - Auth Review summary: Get AuthReview description: Gets AuthReview operationId: GetAuthReview parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authReviewKey in: path description: AuthReview Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth Review summary: Update AuthReview description: Updates a specific AuthReview. operationId: UpdateAuthReview parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authReviewKey in: path description: AuthReview Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReview' text/json: schema: $ref: '#/components/schemas/AuthReview' application/*+json: schema: $ref: '#/components/schemas/AuthReview' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth Review summary: Delete AuthReview description: Deletes an AuthReview operationId: DeleteAuthReview parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authReviewKey in: path description: AuthReview Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-reviews-batch: put: tags: - Auth Review summary: Update Batch AuthReview description: Updates a multiple AuthReview. operationId: UpdateBatchAuthReview parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthReview' text/json: schema: type: array items: $ref: '#/components/schemas/AuthReview' application/*+json: schema: type: array items: $ref: '#/components/schemas/AuthReview' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-review-levels: post: tags: - Auth Review Level summary: Create AuthReviewLevel description: Creates a new AuthReviewLevel. operationId: CreateAuthReviewLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReviewLevel' text/json: schema: $ref: '#/components/schemas/AuthReviewLevel' application/*+json: schema: $ref: '#/components/schemas/AuthReviewLevel' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewLevelVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewLevelVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewLevelVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Auth Review Level summary: List AuthReviewLevel description: Lists all AuthReviewLevel operationId: ListAuthReviewLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewLevelListVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewLevelListVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewLevelListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auth-review-levels/{reviewLevel}': get: tags: - Auth Review Level summary: Get AuthReviewLevel description: Gets AuthReviewLevel operationId: GetAuthReviewLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewLevel in: path description: Review Level required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewLevelVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewLevelVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewLevelVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth Review Level summary: Update AuthReviewLevel description: Updates a specific AuthReviewLevel. operationId: UpdateAuthReviewLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewLevel in: path description: Review Level required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReviewLevel' text/json: schema: $ref: '#/components/schemas/AuthReviewLevel' application/*+json: schema: $ref: '#/components/schemas/AuthReviewLevel' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewLevelVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewLevelVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewLevelVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth Review Level summary: Delete AuthReviewLevel description: Deletes an AuthReviewLevel operationId: DeleteAuthReviewLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewLevel in: path description: Review Level required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-review-levels-batch: put: tags: - Auth Review Level summary: Update Batch AuthReviewLevel description: Updates a multiple AuthReviewLevel. operationId: UpdateBatchAuthReviewLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthReviewLevel' text/json: schema: type: array items: $ref: '#/components/schemas/AuthReviewLevel' application/*+json: schema: type: array items: $ref: '#/components/schemas/AuthReviewLevel' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-review-severities: post: tags: - Auth Review Severity summary: Create AuthReviewSeverity description: Creates a new AuthReviewSeverity. operationId: CreateAuthReviewSeverity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReviewSeverity' text/json: schema: $ref: '#/components/schemas/AuthReviewSeverity' application/*+json: schema: $ref: '#/components/schemas/AuthReviewSeverity' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewSeverityVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewSeverityVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewSeverityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Auth Review Severity summary: List AuthReviewLevel description: Lists all AuthReviewSeverity operationId: ListAuthReviewSeverity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewSeverityListVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewSeverityListVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewSeverityListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auth-review-severities/{reviewSeverity}': get: tags: - Auth Review Severity summary: Get AuthReviewSeverity description: Gets AuthReviewSeverity operationId: GetAuthReviewSeverity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewSeverity in: path description: Review Severity required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewSeverityVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewSeverityVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewSeverityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth Review Severity summary: Update AuthReviewSeverity description: Updates a specific AuthReviewSeverity. operationId: UpdateAuthReviewSeverity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewSeverity in: path description: Review Severity required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReviewSeverity' text/json: schema: $ref: '#/components/schemas/AuthReviewSeverity' application/*+json: schema: $ref: '#/components/schemas/AuthReviewSeverity' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewSeverityVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewSeverityVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewSeverityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth Review Severity summary: Delete AuthReviewSeverity description: Deletes an AuthReviewSeverity operationId: DeleteAuthReviewSeverity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewSeverity in: path description: Review Severity required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-review-severities-batch: put: tags: - Auth Review Severity summary: Update Batch AuthReviewSeverity description: Updates a multiple AuthReviewSeverity. operationId: UpdateBatchAuthReviewSeverity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthReviewSeverity' text/json: schema: type: array items: $ref: '#/components/schemas/AuthReviewSeverity' application/*+json: schema: type: array items: $ref: '#/components/schemas/AuthReviewSeverity' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-review-statuses: post: tags: - Auth Review Status summary: Create AuthReviewStatus description: Creates a new AuthReviewStatus. operationId: CreateAuthReviewStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReviewStatus' text/json: schema: $ref: '#/components/schemas/AuthReviewStatus' application/*+json: schema: $ref: '#/components/schemas/AuthReviewStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Auth Review Status summary: List AuthReviewStatus description: Lists all AuthReviewStatus operationId: ListAuthReviewStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auth-review-statuses/{reviewStatus}': get: tags: - Auth Review Status summary: Get AuthReviewStatus description: Gets AuthReviewStatus operationId: GetAuthReviewStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewStatus in: path description: Review Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth Review Status summary: Update AuthReviewStatus description: Updates a specific AuthReviewStatus. operationId: UpdateAuthReviewStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewStatus in: path description: Review Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReviewStatus' text/json: schema: $ref: '#/components/schemas/AuthReviewStatus' application/*+json: schema: $ref: '#/components/schemas/AuthReviewStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth Review Status summary: Delete AuthReviewStatus description: Deletes an AuthReviewStatus operationId: DeleteAuthReviewStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewStatus in: path description: Review Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-review-statuses-batch: put: tags: - Auth Review Status summary: Update Batch AuthReviewStatus description: Updates a multiple AuthReviewStatus. operationId: UpdateBatchAuthReviewStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthReviewStatus' text/json: schema: type: array items: $ref: '#/components/schemas/AuthReviewStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/AuthReviewStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-review-types: post: tags: - Auth Review Type summary: Create AuthReviewType description: Creates a new AuthReviewType. operationId: CreateAuthReviewType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReviewType' text/json: schema: $ref: '#/components/schemas/AuthReviewType' application/*+json: schema: $ref: '#/components/schemas/AuthReviewType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Auth Review Type summary: List AuthReviewType description: Lists all AuthReviewType operationId: ListAuthReviewType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auth-review-types/{reviewType}': get: tags: - Auth Review Type summary: Get AuthReviewType description: Gets AuthReviewType operationId: GetAuthReviewType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewType in: path description: Review Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth Review Type summary: Update AuthReviewType description: Updates a specific AuthReviewType. operationId: UpdateAuthReviewType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewType in: path description: Review Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReviewType' text/json: schema: $ref: '#/components/schemas/AuthReviewType' application/*+json: schema: $ref: '#/components/schemas/AuthReviewType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth Review Type summary: Delete AuthReviewType description: Deletes an AuthReviewType operationId: DeleteAuthReviewType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewType in: path description: Review Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-review-types-batch: put: tags: - Auth Review Type summary: Update Batch AuthReviewType description: Updates a multiple AuthReviewType. operationId: UpdateBatchAuthReviewType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthReviewType' text/json: schema: type: array items: $ref: '#/components/schemas/AuthReviewType' application/*+json: schema: type: array items: $ref: '#/components/schemas/AuthReviewType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-review-urgency-types: post: tags: - Auth Review Urgency Type summary: Create AuthReviewUrgencyType description: Creates a new AuthReviewUrgencyType. operationId: CreateAuthReviewUrgencyType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReviewUrgencyType' text/json: schema: $ref: '#/components/schemas/AuthReviewUrgencyType' application/*+json: schema: $ref: '#/components/schemas/AuthReviewUrgencyType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewUrgencyTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewUrgencyTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewUrgencyTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Auth Review Urgency Type summary: List AuthReviewUrgencyType description: Lists all AuthReviewUrgencyType operationId: ListAuthReviewUrgencyType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewUrgencyTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewUrgencyTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewUrgencyTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auth-review-urgency-types/{reviewUrgencyType}': get: tags: - Auth Review Urgency Type summary: Get AuthReviewUrgencyType description: Gets AuthReviewUrgencyType operationId: GetAuthReviewUrgencyType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewUrgencyType in: path description: Review Urgency Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewUrgencyTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewUrgencyTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewUrgencyTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth Review Urgency Type summary: Update AuthReviewUrgencyType description: Updates a specific AuthReviewUrgencyType. operationId: UpdateAuthReviewUrgencyType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewUrgencyType in: path description: Review Urgency Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthReviewUrgencyType' text/json: schema: $ref: '#/components/schemas/AuthReviewUrgencyType' application/*+json: schema: $ref: '#/components/schemas/AuthReviewUrgencyType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthReviewUrgencyTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthReviewUrgencyTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthReviewUrgencyTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth Review Urgency Type summary: Delete AuthReviewUrgencyType description: Deletes an AuthReviewUrgencyType operationId: DeleteAuthReviewUrgencyType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reviewUrgencyType in: path description: Review Urgency Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-review-urgency-types-batch: put: tags: - Auth Review Urgency Type summary: Update Batch AuthReviewUrgencyType description: Updates a multiple AuthReviewUrgencyType. operationId: UpdateBatchAuthReviewUrgencyType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthReviewUrgencyType' text/json: schema: type: array items: $ref: '#/components/schemas/AuthReviewUrgencyType' application/*+json: schema: type: array items: $ref: '#/components/schemas/AuthReviewUrgencyType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-max-calc: get: tags: - Auth Max Calc summary: List Auth Max Calc description: Lists all Auth Max Calc operationId: ListAuthMaxCalc parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-types: post: tags: - Auth Types summary: Create AuthType description: Creates a new AuthType operationId: CreateAuthType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthType' text/json: schema: $ref: '#/components/schemas/AuthType' application/*+json: schema: $ref: '#/components/schemas/AuthType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Auth Types summary: List AuthType description: Lists all AuthType operationId: ListAuthType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auth-types/{authType}': get: tags: - Auth Types summary: Get AuthType description: Gets AuthType operationId: GetAuthType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authType in: path description: Auth Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth Types summary: Update AuthType description: Updates a specific AuthType. operationId: UpdateAuthType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authType in: path description: Auth Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthType' text/json: schema: $ref: '#/components/schemas/AuthType' application/*+json: schema: $ref: '#/components/schemas/AuthType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth Types summary: Delete AuthType description: Deletes an AuthType operationId: DeleteAuthType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authType in: path description: Auth Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auth-types-batch: put: tags: - Auth Types summary: Create or Update Batch AuthType description: 'Create or Update multiple AuthType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchAuthType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthType' text/json: schema: type: array items: $ref: '#/components/schemas/AuthType' application/*+json: schema: type: array items: $ref: '#/components/schemas/AuthType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auth-types/{authType}/places': post: tags: - Auth Type Places summary: Create AuthTypePlace description: Creates a new AuthTypePlace operationId: CreateAuthTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authType in: path description: Auth Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthTypePlace' text/json: schema: $ref: '#/components/schemas/AuthTypePlace' application/*+json: schema: $ref: '#/components/schemas/AuthTypePlace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthTypePlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthTypePlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthTypePlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Auth Type Places summary: List AuthTypePlace description: Lists all AuthTypePlace for the given authType operationId: ListAuthTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authType in: path description: Auth Type required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthTypePlaceListVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthTypePlaceListVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthTypePlaceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auth-types/{authType}/places/{placeOfService}': get: tags: - Auth Type Places summary: Get AuthTypePlace description: Gets AuthTypePlace operationId: GetAuthTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authType in: path description: Auth Type required: true schema: type: string - name: placeOfService in: path description: Place Of Service required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthTypePlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthTypePlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthTypePlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Auth Type Places summary: Update AuthTypePlace description: Updates a specific AuthTypePlace. operationId: UpdateAuthTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authType in: path description: Auth Type required: true schema: type: string - name: placeOfService in: path description: Place Of Service required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthTypePlace' text/json: schema: $ref: '#/components/schemas/AuthTypePlace' application/*+json: schema: $ref: '#/components/schemas/AuthTypePlace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthTypePlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/AuthTypePlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/AuthTypePlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Auth Type Places summary: Delete AuthTypePlace description: Deletes an AuthTypePlace operationId: DeleteAuthTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authType in: path description: Auth Type required: true schema: type: string - name: placeOfService in: path description: Place Of Service required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/auth-types/{authType}/places-batch': put: tags: - Auth Type Places summary: Create or Update Batch AuthTypePlace description: 'Create or Update multiple AuthTypePlace at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchAuthTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: authType in: path description: Auth Type required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthTypePlace' text/json: schema: type: array items: $ref: '#/components/schemas/AuthTypePlace' application/*+json: schema: type: array items: $ref: '#/components/schemas/AuthTypePlace' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /benefit-categories: post: tags: - Benefit Categories summary: Create BenefitCategory description: Creates a new BenefitCategory operationId: CreateBenefitCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitCategory' text/json: schema: $ref: '#/components/schemas/BenefitCategory' application/*+json: schema: $ref: '#/components/schemas/BenefitCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Benefit Categories summary: List BenefitCategory description: 'Lists all BenefitCategory ' operationId: ListBenefitCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefit-categories/{benefitCategory}': get: tags: - Benefit Categories summary: Get BenefitCategory description: Gets BenefitCategory operationId: GetBenefitCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCategory in: path description: Benefit Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Benefit Categories summary: Update BenefitCategory description: Updates a specific BenefitCategory. operationId: UpdateBenefitCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCategory in: path description: Benefit Category required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitCategory' text/json: schema: $ref: '#/components/schemas/BenefitCategory' application/*+json: schema: $ref: '#/components/schemas/BenefitCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Benefit Categories summary: Delete BenefitCategory description: Deletes an BenefitCategory operationId: DeleteBenefitCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCategory in: path description: Benefit Category required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /benefit-categories-batch: put: tags: - Benefit Categories summary: Create or Update Batch BenefitCategory description: 'Create or Update multiple BenefitCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchBenefitCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/BenefitCategory' text/json: schema: type: array items: $ref: '#/components/schemas/BenefitCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/BenefitCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /benefits: post: tags: - Benefits summary: Create Benefit description: Creates a new Benefit operationId: CreateBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitCodes' text/json: schema: $ref: '#/components/schemas/BenefitCodes' application/*+json: schema: $ref: '#/components/schemas/BenefitCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Benefits summary: List Benefits description: Lists all Benefits with optional Benefit Category operationId: ListBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: benefitCategory in: query description: Filter schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitCodesListVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitCodesListVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitCodesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planId}/benefits/riders': get: tags: - Benefits summary: List Benefit Riders description: Lists all Benefits that are Riders on a specific Plan operationId: ListBenefitPlanRiders parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planId in: path description: PlanId required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitCodesListVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitCodesListVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitCodesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}': get: tags: - Benefits summary: Get a Benefit description: Gets a specific Benefit by Benefit Code operationId: GetBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Benefits summary: Update Benefit description: Updates a specific Benefit operationId: UpdateBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitCodes' text/json: schema: $ref: '#/components/schemas/BenefitCodes' application/*+json: schema: $ref: '#/components/schemas/BenefitCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Benefits summary: Delete a Benefit description: Deletes a specific Benefit by Benefit Code operationId: DeleteBenefitCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /benefits-batch: put: tags: - Benefits summary: Create or Update Batch of Benefits description: 'Create or Update multiple Benefits at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/BenefitCodes' text/json: schema: type: array items: $ref: '#/components/schemas/BenefitCodes' application/*+json: schema: type: array items: $ref: '#/components/schemas/BenefitCodes' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/diagnoses': post: tags: - Benefit Diagnostic Codes summary: Create BenefitDiagCodes description: Creates a new BenefitDiagCodes operationId: CreateBenefitDiagCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitDiagCodes' text/json: schema: $ref: '#/components/schemas/BenefitDiagCodes' application/*+json: schema: $ref: '#/components/schemas/BenefitDiagCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitDiagCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitDiagCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitDiagCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Benefit Diagnostic Codes summary: List BenefitDiagCodes description: Lists all BenefitDiagCodes for the given benefitCode operationId: ListBenefitDiagCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitDiagCodesListVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitDiagCodesListVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitDiagCodesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/diagnoses/{diagnosticCodeType}/{fromDiagCode}': get: tags: - Benefit Diagnostic Codes summary: Get BenefitDiagCodes description: Gets BenefitDiagCodes operationId: GetBenefitDiagCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: fromDiagCode in: path description: From Diag Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitDiagCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitDiagCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitDiagCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Benefit Diagnostic Codes summary: Update BenefitDiagCodes description: Updates a specific BenefitDiagCodes. operationId: UpdateBenefitDiagCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: fromDiagCode in: path description: From Diag Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitDiagCodes' text/json: schema: $ref: '#/components/schemas/BenefitDiagCodes' application/*+json: schema: $ref: '#/components/schemas/BenefitDiagCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitDiagCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitDiagCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitDiagCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Benefit Diagnostic Codes summary: Delete BenefitDiagCodes description: Deletes an BenefitDiagCodes operationId: DeleteBenefitDiagCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: fromDiagCode in: path description: From Diag Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/diagnoses-batch': put: tags: - Benefit Diagnostic Codes summary: Create or Update Batch BenefitDiagCodes description: 'Create or Update multiple BenefitDiagCodes at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchBenefitDiagCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/BenefitDiagCodes' text/json: schema: type: array items: $ref: '#/components/schemas/BenefitDiagCodes' application/*+json: schema: type: array items: $ref: '#/components/schemas/BenefitDiagCodes' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/places': post: tags: - Benefit Places summary: Create BenefitPlace description: Creates a new BenefitPlace operationId: CreateBenefitPlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitPlace' text/json: schema: $ref: '#/components/schemas/BenefitPlace' application/*+json: schema: $ref: '#/components/schemas/BenefitPlace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitPlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitPlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitPlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Benefit Places summary: List BenefitPlace description: Lists all BenefitPlace benefitCode operationId: ListBenefitPlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitPlaceListVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitPlaceListVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitPlaceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/places/{placeCode}': get: tags: - Benefit Places summary: Get BenefitPlace description: Gets BenefitPlace operationId: GetBenefitPlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitPlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitPlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitPlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Benefit Places summary: Update BenefitPlace description: Updates a specific BenefitPlace. operationId: UpdateBenefitPlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitPlace' text/json: schema: $ref: '#/components/schemas/BenefitPlace' application/*+json: schema: $ref: '#/components/schemas/BenefitPlace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitPlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitPlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitPlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Benefit Places summary: Delete BenefitPlace description: Deletes an BenefitPlace operationId: DeleteBenefitPlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/places-batch': put: tags: - Benefit Places summary: Create or Update Batch BenefitPlace description: 'Create or Update multiple BenefitPlace at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchBenefitPlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/BenefitPlace' text/json: schema: type: array items: $ref: '#/components/schemas/BenefitPlace' application/*+json: schema: type: array items: $ref: '#/components/schemas/BenefitPlace' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/procedures': post: tags: - Benefit Procedures summary: Create BenefitProcedures description: Creates a new BenefitProcedures operationId: CreateBenefitProcedures parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitProcedures' text/json: schema: $ref: '#/components/schemas/BenefitProcedures' application/*+json: schema: $ref: '#/components/schemas/BenefitProcedures' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitProceduresVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitProceduresVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitProceduresVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Benefit Procedures summary: List BenefitProcedures description: Lists all BenefitProcedures benefitCode operationId: ListBenefitProcedures parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitProceduresListVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitProceduresListVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitProceduresListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/procedures/{fromProcedure}': get: tags: - Benefit Procedures summary: Get BenefitProcedures description: Gets BenefitProcedures operationId: GetBenefitProcedures parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: fromProcedure in: path description: From Procedure required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitProceduresVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitProceduresVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitProceduresVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Benefit Procedures summary: Update BenefitProcedures description: Updates a specific BenefitProcedures. operationId: UpdateBenefitProcedures parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: fromProcedure in: path description: From Procedure required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitProcedures' text/json: schema: $ref: '#/components/schemas/BenefitProcedures' application/*+json: schema: $ref: '#/components/schemas/BenefitProcedures' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitProceduresVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitProceduresVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitProceduresVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Benefit Procedures summary: Delete BenefitProcedures description: Deletes an BenefitProcedures operationId: DeleteBenefitProcedures parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: fromProcedure in: path description: From Procedure required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/procedures-batch': put: tags: - Benefit Procedures summary: Create or Update Batch BenefitProcedures description: 'Create or Update multiple BenefitProcedures at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchBenefitProcedures parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/BenefitProcedures' text/json: schema: type: array items: $ref: '#/components/schemas/BenefitProcedures' application/*+json: schema: type: array items: $ref: '#/components/schemas/BenefitProcedures' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/provider-types': post: tags: - Benefit Provider Types summary: Create BenefitProviderTypes description: Creates a new BenefitProviderTypes operationId: CreateBenefitProviderTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitProviderTypes' text/json: schema: $ref: '#/components/schemas/BenefitProviderTypes' application/*+json: schema: $ref: '#/components/schemas/BenefitProviderTypes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitProviderTypesVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitProviderTypesVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitProviderTypesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Benefit Provider Types summary: List BenefitProviderTypes description: Lists all BenefitProviderTypes benefitCode operationId: ListBenefitProviderTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitProviderTypesListVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitProviderTypesListVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitProviderTypesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/provider-types/{providerType}': get: tags: - Benefit Provider Types summary: Get BenefitProviderTypes description: Gets BenefitProviderTypes operationId: GetBenefitProviderTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: providerType in: path description: Provider Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitProviderTypesVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitProviderTypesVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitProviderTypesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Benefit Provider Types summary: Update BenefitProviderTypes description: Updates a specific BenefitProviderTypes. operationId: UpdateBenefitProviderTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: providerType in: path description: Provider Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitProviderTypes' text/json: schema: $ref: '#/components/schemas/BenefitProviderTypes' application/*+json: schema: $ref: '#/components/schemas/BenefitProviderTypes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitProviderTypesVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitProviderTypesVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitProviderTypesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Benefit Provider Types summary: Delete BenefitProviderTypes description: Deletes an BenefitProviderTypes operationId: DeleteBenefitProviderTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: providerType in: path description: Provider Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/provider-types-batch': put: tags: - Benefit Provider Types summary: Create or Update Batch BenefitProviderTypes description: 'Create or Update multiple BenefitProviderTypes at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchBenefitProviderTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/BenefitProviderTypes' text/json: schema: type: array items: $ref: '#/components/schemas/BenefitProviderTypes' application/*+json: schema: type: array items: $ref: '#/components/schemas/BenefitProviderTypes' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/specialty-codes': post: tags: - Benefit Specialties summary: Create BenefitSpecialty description: Creates a new BenefitSpecialty operationId: CreateBenefitSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitSpecialty' text/json: schema: $ref: '#/components/schemas/BenefitSpecialty' application/*+json: schema: $ref: '#/components/schemas/BenefitSpecialty' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitSpecialtyVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitSpecialtyVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitSpecialtyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Benefit Specialties summary: List BenefitSpecialty description: Lists all BenefitSpecialty benefitCode operationId: ListBenefitSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitSpecialtyListVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitSpecialtyListVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitSpecialtyListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/specialty-codes/{specialtyCode}': get: tags: - Benefit Specialties summary: Get BenefitSpecialty description: Gets BenefitSpecialty operationId: GetBenefitSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: specialtyCode in: path description: Specialty Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitSpecialtyVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitSpecialtyVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitSpecialtyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Benefit Specialties summary: Update BenefitSpecialty description: Updates a specific BenefitSpecialty. operationId: UpdateBenefitSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: specialtyCode in: path description: Specialty Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BenefitSpecialty' text/json: schema: $ref: '#/components/schemas/BenefitSpecialty' application/*+json: schema: $ref: '#/components/schemas/BenefitSpecialty' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitSpecialtyVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitSpecialtyVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitSpecialtyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Benefit Specialties summary: Delete BenefitSpecialty description: Deletes an BenefitSpecialty operationId: DeleteBenefitSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: specialtyCode in: path description: Specialty Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/benefits/{benefitCode}/specialty-codes-batch': put: tags: - Benefit Specialties summary: Create or Update Batch BenefitSpecialty description: 'Create or Update multiple BenefitSpecialty at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchBenefitSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/BenefitSpecialty' text/json: schema: type: array items: $ref: '#/components/schemas/BenefitSpecialty' application/*+json: schema: type: array items: $ref: '#/components/schemas/BenefitSpecialty' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/list-generate-bill/{invoiceDate}': get: tags: - Premium Invoices - Adv. Billing summary: List Invoices to be Generated description: List of Invoices to be generated based on the selected Invoice Date. operationId: ListPremInvoiceGenerate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceDate in: path description: Invoice Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceGenerateInvListListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceGenerateInvListListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceGenerateInvListListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/list-generate-self-admin/{invoiceDate}': get: tags: - Premium Invoices - Adv. Billing summary: List Self-Admin Invoices to be Generated description: List of Self-Admin Invoices to be generated based on the selected Invoice Date. operationId: ListPremInvoiceGenerateSelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceDate in: path description: Invoice Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceGenerateSelfAdminInvListListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceGenerateSelfAdminInvListListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceGenerateSelfAdminInvListListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /generate-subscriber-invoice: post: tags: - Premium Invoices - Adv. Billing summary: Generate Subscriber Invoice description: Creates a new Premium Billing Invoice for the selected Subscriber. operationId: GeneratePremInvoiceSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GeneratePremInvoice' text/json: schema: $ref: '#/components/schemas/GeneratePremInvoice' application/*+json: schema: $ref: '#/components/schemas/GeneratePremInvoice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /generate-group-invoice: post: tags: - Premium Invoices - Adv. Billing summary: Generate Group Invoice description: Creates a new Premium Billing Invoice for the selected Group. operationId: GeneratePremInvoiceGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GeneratePremInvoice' text/json: schema: $ref: '#/components/schemas/GeneratePremInvoice' application/*+json: schema: $ref: '#/components/schemas/GeneratePremInvoice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /generate-division-invoice: post: tags: - Premium Invoices - Adv. Billing summary: Generate Division Invoice description: Creates a new Premium Billing Invoice for the selected Group/Division. operationId: GeneratePremInvoiceDivision parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GeneratePremInvoice' text/json: schema: $ref: '#/components/schemas/GeneratePremInvoice' application/*+json: schema: $ref: '#/components/schemas/GeneratePremInvoice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /generate-group-division-invoice: post: tags: - Premium Invoices - Adv. Billing summary: Generate Group and Division Invoice description: Creates a new Premium Billing Invoice the selected Group for any Division with the Group Invoice Level AND a separate Invoice for each Division flagged as Division Invoice Level. operationId: GeneratePremInvoiceGroupDivision parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GeneratePremInvoice' text/json: schema: $ref: '#/components/schemas/GeneratePremInvoice' application/*+json: schema: $ref: '#/components/schemas/GeneratePremInvoice' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /generate-self-admin-group-invoice: post: tags: - Premium Invoices - Adv. Billing summary: Generate Self-Admin Group Invoice description: Creates a new Self-Admin Invoice for the selected Group. operationId: GeneratePremInvoiceSelfAdminGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GeneratePremInvoice' text/json: schema: $ref: '#/components/schemas/GeneratePremInvoice' application/*+json: schema: $ref: '#/components/schemas/GeneratePremInvoice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /generate-self-admin-division-invoice: post: tags: - Premium Invoices - Adv. Billing summary: Generate Self-Admin Division Invoice description: Creates a new Self-Admin Invoice for the selected Group/Division. operationId: GeneratePremInvoiceSelfAdminDivision parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GeneratePremInvoice' text/json: schema: $ref: '#/components/schemas/GeneratePremInvoice' application/*+json: schema: $ref: '#/components/schemas/GeneratePremInvoice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /billing-refund: post: tags: - Billing - Adv. Billing summary: Billing Refund description: Generate the necessary Billing adjustments for an Invoice refund and create a Distribution if needed. operationId: BillingRefund parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingRefund' text/json: schema: $ref: '#/components/schemas/BillingRefund' application/*+json: schema: $ref: '#/components/schemas/BillingRefund' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /billing-basis: post: tags: - Billing Basis summary: Create BillingBasis description: Creates a new BillingBasis operationId: CreateBillingBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingBasis' text/json: schema: $ref: '#/components/schemas/BillingBasis' application/*+json: schema: $ref: '#/components/schemas/BillingBasis' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillingBasisVBAResponse' application/json: schema: $ref: '#/components/schemas/BillingBasisVBAResponse' text/json: schema: $ref: '#/components/schemas/BillingBasisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Billing Basis summary: List BillingBasis description: Lists all BillingBasis operationId: ListBillingBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillingBasisListVBAResponse' application/json: schema: $ref: '#/components/schemas/BillingBasisListVBAResponse' text/json: schema: $ref: '#/components/schemas/BillingBasisListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/billing-basis/{billingBasis}': get: tags: - Billing Basis summary: Get BillingBasis description: Gets BillingBasis operationId: GetBillingBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: billingBasis in: path description: Billing Basis required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillingBasisVBAResponse' application/json: schema: $ref: '#/components/schemas/BillingBasisVBAResponse' text/json: schema: $ref: '#/components/schemas/BillingBasisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Billing Basis summary: Update BillingBasis description: Updates a specific BillingBasis. operationId: UpdateBillingBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: billingBasis in: path description: Billing Basis required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingBasis' text/json: schema: $ref: '#/components/schemas/BillingBasis' application/*+json: schema: $ref: '#/components/schemas/BillingBasis' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillingBasisVBAResponse' application/json: schema: $ref: '#/components/schemas/BillingBasisVBAResponse' text/json: schema: $ref: '#/components/schemas/BillingBasisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Billing Basis summary: Delete BillingBasis description: Deletes an BillingBasis operationId: DeleteBillingBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: billingBasis in: path description: Billing Basis required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /billing-basis-batch: put: tags: - Billing Basis summary: Create or Update Batch BillingBasis description: 'Create or Update multiple BillingBasis at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchBillingBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/BillingBasis' text/json: schema: type: array items: $ref: '#/components/schemas/BillingBasis' application/*+json: schema: type: array items: $ref: '#/components/schemas/BillingBasis' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /billing-cycles: post: tags: - Billing Cycles summary: Create BillingCycle description: Creates a new BillingCycle operationId: CreateBillingCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingCycle' text/json: schema: $ref: '#/components/schemas/BillingCycle' application/*+json: schema: $ref: '#/components/schemas/BillingCycle' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillingCycleVBAResponse' application/json: schema: $ref: '#/components/schemas/BillingCycleVBAResponse' text/json: schema: $ref: '#/components/schemas/BillingCycleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Billing Cycles summary: List BillingCycle description: Lists all BillingCycle operationId: ListBillingCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillingCycleListVBAResponse' application/json: schema: $ref: '#/components/schemas/BillingCycleListVBAResponse' text/json: schema: $ref: '#/components/schemas/BillingCycleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/billing-cycles/{billingCycleID}': get: tags: - Billing Cycles summary: Get BillingCycle description: Gets BillingCycle operationId: GetBillingCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: billingCycleID in: path description: Billing Cycle ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillingCycleVBAResponse' application/json: schema: $ref: '#/components/schemas/BillingCycleVBAResponse' text/json: schema: $ref: '#/components/schemas/BillingCycleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Billing Cycles summary: Update BillingCycle description: Updates a specific BillingCycle. operationId: UpdateBillingCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: billingCycleID in: path description: Billing Cycle ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingCycle' text/json: schema: $ref: '#/components/schemas/BillingCycle' application/*+json: schema: $ref: '#/components/schemas/BillingCycle' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillingCycleVBAResponse' application/json: schema: $ref: '#/components/schemas/BillingCycleVBAResponse' text/json: schema: $ref: '#/components/schemas/BillingCycleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Billing Cycles summary: Delete BillingCycle description: Deletes an BillingCycle operationId: DeleteBillingCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: billingCycleID in: path description: Billing Cycle ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /billing-cycles-batch: put: tags: - Billing Cycles summary: Create or Update Batch BillingCycle description: 'Create or Update multiple BillingCycle at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchBillingCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/BillingCycle' text/json: schema: type: array items: $ref: '#/components/schemas/BillingCycle' application/*+json: schema: type: array items: $ref: '#/components/schemas/BillingCycle' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /bill-types: post: tags: - Bill Types summary: Create BillType description: Creates a new BillType operationId: CreateBillType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BillType' text/json: schema: $ref: '#/components/schemas/BillType' application/*+json: schema: $ref: '#/components/schemas/BillType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/BillTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/BillTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Bill Types summary: List BillType description: Lists all BillType operationId: ListBillType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/BillTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/BillTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/bill-types/{typeOfBill}': get: tags: - Bill Types summary: Get BillType description: Gets BillType operationId: GetBillType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: typeOfBill in: path description: Type Of Bill required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/BillTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/BillTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Bill Types summary: Update BillType description: Updates a specific BillType. operationId: UpdateBillType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: typeOfBill in: path description: Type Of Bill required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BillType' text/json: schema: $ref: '#/components/schemas/BillType' application/*+json: schema: $ref: '#/components/schemas/BillType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/BillTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/BillTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Bill Types summary: Delete BillType description: Deletes an BillType operationId: DeleteBillType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: typeOfBill in: path description: Type Of Bill required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /bill-types-batch: put: tags: - Bill Types summary: Create or Update Batch BillType description: 'Create or Update multiple BillType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchBillType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/BillType' text/json: schema: type: array items: $ref: '#/components/schemas/BillType' application/*+json: schema: type: array items: $ref: '#/components/schemas/BillType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/bill-types/{typeOfBill}/places': post: tags: - Bill Type Places summary: Create BillTypePlace description: Creates a new BillTypePlace operationId: CreateBillTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: typeOfBill in: path description: Type Of Bill required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BillTypePlace' text/json: schema: $ref: '#/components/schemas/BillTypePlace' application/*+json: schema: $ref: '#/components/schemas/BillTypePlace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillTypePlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/BillTypePlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/BillTypePlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Bill Type Places summary: List BillTypePlace description: Lists all BillTypePlace for the given typeOfBill operationId: ListBillTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: typeOfBill in: path description: Type Of Bill required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillTypePlaceListVBAResponse' application/json: schema: $ref: '#/components/schemas/BillTypePlaceListVBAResponse' text/json: schema: $ref: '#/components/schemas/BillTypePlaceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/bill-types/{typeOfBill}/places/{placeOfService}': get: tags: - Bill Type Places summary: Get BillTypePlace description: Gets BillTypePlace operationId: GetBillTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: typeOfBill in: path description: Type Of Bill required: true schema: type: string - name: placeOfService in: path description: Place Of Service required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillTypePlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/BillTypePlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/BillTypePlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Bill Type Places summary: Update BillTypePlace description: Updates a specific BillTypePlace. operationId: UpdateBillTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: typeOfBill in: path description: Type Of Bill required: true schema: type: string - name: placeOfService in: path description: Place Of Service required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BillTypePlace' text/json: schema: $ref: '#/components/schemas/BillTypePlace' application/*+json: schema: $ref: '#/components/schemas/BillTypePlace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BillTypePlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/BillTypePlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/BillTypePlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Bill Type Places summary: Delete BillTypePlace description: Deletes an BillTypePlace operationId: DeleteBillTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: typeOfBill in: path description: Type Of Bill required: true schema: type: string - name: placeOfService in: path description: Place Of Service required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/bill-types/{typeOfBill}/places-batch': put: tags: - Bill Type Places summary: Create or Update Batch BillTypePlace description: 'Create or Update multiple BillTypePlace at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchBillTypePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: typeOfBill in: path description: Type Of Bill required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/BillTypePlace' text/json: schema: type: array items: $ref: '#/components/schemas/BillTypePlace' application/*+json: schema: type: array items: $ref: '#/components/schemas/BillTypePlace' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /brokerages: post: tags: - Brokerage summary: Create Brokerage description: Creates a new Brokerage operationId: CreateBrokerage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Brokerage' text/json: schema: $ref: '#/components/schemas/Brokerage' application/*+json: schema: $ref: '#/components/schemas/Brokerage' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BrokerageVBAResponse' application/json: schema: $ref: '#/components/schemas/BrokerageVBAResponse' text/json: schema: $ref: '#/components/schemas/BrokerageVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Brokerage summary: List Brokerage description: Lists all Brokerage operationId: ListBrokerage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BrokerageListVBAResponse' application/json: schema: $ref: '#/components/schemas/BrokerageListVBAResponse' text/json: schema: $ref: '#/components/schemas/BrokerageListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/brokerages/{brokerage}': get: tags: - Brokerage summary: Get Brokerage description: Gets Brokerage operationId: GetBrokerage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: brokerage in: path description: Brokerage1 required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BrokerageVBAResponse' application/json: schema: $ref: '#/components/schemas/BrokerageVBAResponse' text/json: schema: $ref: '#/components/schemas/BrokerageVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Brokerage summary: Update Brokerage description: Updates a specific Brokerage. operationId: UpdateBrokerage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: brokerage in: path description: Brokerage1 required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Brokerage' text/json: schema: $ref: '#/components/schemas/Brokerage' application/*+json: schema: $ref: '#/components/schemas/Brokerage' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BrokerageVBAResponse' application/json: schema: $ref: '#/components/schemas/BrokerageVBAResponse' text/json: schema: $ref: '#/components/schemas/BrokerageVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Brokerage summary: Delete Brokerage description: Deletes an Brokerage operationId: DeleteBrokerage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: brokerage in: path description: Brokerage1 required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /brokerages-batch: put: tags: - Brokerage summary: Create or Update Batch Brokerage description: 'Create or Update multiple Brokerage at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchBrokerage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Brokerage' text/json: schema: type: array items: $ref: '#/components/schemas/Brokerage' application/*+json: schema: type: array items: $ref: '#/components/schemas/Brokerage' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /call-trackings: post: tags: - Call Trackings summary: Create CallTracking description: Creates a new CallTracking operationId: CreateCallTracking parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTracking' text/json: schema: $ref: '#/components/schemas/CallTracking' application/*+json: schema: $ref: '#/components/schemas/CallTracking' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Call Trackings summary: List CallTracking description: Lists all CallTracking operationId: ListCallTracking parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingListVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingListVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/call-trackings/{callKey}': get: tags: - Call Trackings summary: Get CallTracking description: Gets CallTracking operationId: GetCallTracking parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callKey in: path description: Call Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Call Trackings summary: Update CallTracking description: Updates a specific CallTracking. operationId: UpdateCallTracking parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callKey in: path description: Call Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTracking' text/json: schema: $ref: '#/components/schemas/CallTracking' application/*+json: schema: $ref: '#/components/schemas/CallTracking' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Call Trackings summary: Delete CallTracking description: Deletes an CallTracking operationId: DeleteCallTracking parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callKey in: path description: Call Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /call-trackings-batch: put: tags: - Call Trackings summary: Create or Update Batch CallTracking description: 'Create or Update multiple CallTracking at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCallTracking parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CallTracking' text/json: schema: type: array items: $ref: '#/components/schemas/CallTracking' application/*+json: schema: type: array items: $ref: '#/components/schemas/CallTracking' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /call-destinations: post: tags: - Call Destinations summary: Create CallTrackingCallDestination description: Creates a new CallTrackingCallDestination operationId: CreateCallTrackingCallDestination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTrackingCallDestination' text/json: schema: $ref: '#/components/schemas/CallTrackingCallDestination' application/*+json: schema: $ref: '#/components/schemas/CallTrackingCallDestination' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallDestinationVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallDestinationVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallDestinationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Call Destinations summary: List CallTrackingCallDestination description: Lists all CallTrackingCallDestination operationId: ListCallTrackingCallDestination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallDestinationListVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallDestinationListVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallDestinationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/call-destinations/{callDestination}': get: tags: - Call Destinations summary: Get CallTrackingCallDestination description: Gets CallTrackingCallDestination operationId: GetCallTrackingCallDestination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callDestination in: path description: Call Destination required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallDestinationVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallDestinationVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallDestinationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Call Destinations summary: Update CallTrackingCallDestination description: Updates a specific CallTrackingCallDestination. operationId: UpdateCallTrackingCallDestination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callDestination in: path description: Call Destination required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTrackingCallDestination' text/json: schema: $ref: '#/components/schemas/CallTrackingCallDestination' application/*+json: schema: $ref: '#/components/schemas/CallTrackingCallDestination' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallDestinationVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallDestinationVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallDestinationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Call Destinations summary: Delete CallTrackingCallDestination description: Deletes an CallTrackingCallDestination operationId: DeleteCallTrackingCallDestination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callDestination in: path description: Call Destination required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /call-destinations-batch: put: tags: - Call Destinations summary: Create or Update Batch CallTrackingCallDestination description: 'Create or Update multiple CallTrackingCallDestination at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCallTrackingCallDestination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingCallDestination' text/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingCallDestination' application/*+json: schema: type: array items: $ref: '#/components/schemas/CallTrackingCallDestination' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /caller-types: post: tags: - Caller Types summary: Create CallTrackingCallerType description: Creates a new CallTrackingCallerType operationId: CreateCallTrackingCallerType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTrackingCallerType' text/json: schema: $ref: '#/components/schemas/CallTrackingCallerType' application/*+json: schema: $ref: '#/components/schemas/CallTrackingCallerType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallerTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallerTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallerTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Caller Types summary: List CallTrackingCallerType description: Lists all CallTrackingCallerType operationId: ListCallTrackingCallerType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallerTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallerTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallerTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/caller-types/{callerType}': get: tags: - Caller Types summary: Get CallTrackingCallerType description: Gets CallTrackingCallerType operationId: GetCallTrackingCallerType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callerType in: path description: Caller Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallerTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallerTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallerTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Caller Types summary: Update CallTrackingCallerType description: Updates a specific CallTrackingCallerType. operationId: UpdateCallTrackingCallerType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callerType in: path description: Caller Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTrackingCallerType' text/json: schema: $ref: '#/components/schemas/CallTrackingCallerType' application/*+json: schema: $ref: '#/components/schemas/CallTrackingCallerType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallerTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallerTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallerTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Caller Types summary: Delete CallTrackingCallerType description: Deletes an CallTrackingCallerType operationId: DeleteCallTrackingCallerType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callerType in: path description: Caller Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /caller-types-batch: put: tags: - Caller Types summary: Create or Update Batch CallTrackingCallerType description: 'Create or Update multiple CallTrackingCallerType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCallTrackingCallerType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingCallerType' text/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingCallerType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CallTrackingCallerType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /call-statuses: post: tags: - Call Statuses summary: Create CallTrackingCallStatus description: Creates a new CallTrackingCallStatus operationId: CreateCallTrackingCallStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTrackingCallStatus' text/json: schema: $ref: '#/components/schemas/CallTrackingCallStatus' application/*+json: schema: $ref: '#/components/schemas/CallTrackingCallStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Call Statuses summary: List CallTrackingCallStatus description: Lists all CallTrackingCallStatus operationId: ListCallTrackingCallStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/call-statuses/{callStatus}': get: tags: - Call Statuses summary: Get CallTrackingCallStatus description: Gets CallTrackingCallStatus operationId: GetCallTrackingCallStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callStatus in: path description: Call Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Call Statuses summary: Update CallTrackingCallStatus description: Updates a specific CallTrackingCallStatus. operationId: UpdateCallTrackingCallStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callStatus in: path description: Call Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTrackingCallStatus' text/json: schema: $ref: '#/components/schemas/CallTrackingCallStatus' application/*+json: schema: $ref: '#/components/schemas/CallTrackingCallStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Call Statuses summary: Delete CallTrackingCallStatus description: Deletes an CallTrackingCallStatus operationId: DeleteCallTrackingCallStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callStatus in: path description: Call Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /call-statuses-batch: put: tags: - Call Statuses summary: Create or Update Batch CallTrackingCallStatus description: 'Create or Update multiple CallTrackingCallStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCallTrackingCallStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingCallStatus' text/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingCallStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/CallTrackingCallStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /call-types: post: tags: - Call Types summary: Create CallTrackingCallType description: Creates a new CallTrackingCallType operationId: CreateCallTrackingCallType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTrackingCallType' text/json: schema: $ref: '#/components/schemas/CallTrackingCallType' application/*+json: schema: $ref: '#/components/schemas/CallTrackingCallType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Call Types summary: List CallTrackingCallType description: Lists all CallTrackingCallType operationId: ListCallTrackingCallType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/call-types/{callType}': get: tags: - Call Types summary: Get CallTrackingCallType description: Gets CallTrackingCallType operationId: GetCallTrackingCallType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callType in: path description: Call Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Call Types summary: Update CallTrackingCallType description: Updates a specific CallTrackingCallType. operationId: UpdateCallTrackingCallType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callType in: path description: Call Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTrackingCallType' text/json: schema: $ref: '#/components/schemas/CallTrackingCallType' application/*+json: schema: $ref: '#/components/schemas/CallTrackingCallType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingCallTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingCallTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingCallTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Call Types summary: Delete CallTrackingCallType description: Deletes an CallTrackingCallType operationId: DeleteCallTrackingCallType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callType in: path description: Call Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /call-types-batch: put: tags: - Call Types summary: Create or Update Batch CallTrackingCallType description: 'Create or Update multiple CallTrackingCallType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCallTrackingCallType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingCallType' text/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingCallType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CallTrackingCallType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /call-tracking-diag-codes: post: tags: - CallTrackingDiagCodes summary: Create CallTrackingDiagCodes description: Creates a new CallTrackingDiagCodes operationId: CreateCallTrackingDiagCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTrackingDiagCodes' text/json: schema: $ref: '#/components/schemas/CallTrackingDiagCodes' application/*+json: schema: $ref: '#/components/schemas/CallTrackingDiagCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingDiagCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingDiagCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingDiagCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - CallTrackingDiagCodes summary: List CallTrackingDiagCodes description: Lists all CallTrackingDiagCodes operationId: ListCallTrackingDiagCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingDiagCodesListVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingDiagCodesListVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingDiagCodesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/call-tracking-diag-codes/{CallTrackingDiagCodes_Key}': get: tags: - CallTrackingDiagCodes summary: Get CallTrackingDiagCodes description: Gets CallTrackingDiagCodes operationId: GetCallTrackingDiagCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CallTrackingDiagCodes_Key in: path description: CallTrackingDiagCodes Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingDiagCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingDiagCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingDiagCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - CallTrackingDiagCodes summary: Update CallTrackingDiagCodes description: Updates a specific CallTrackingDiagCodes. operationId: UpdateCallTrackingDiagCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CallTrackingDiagCodes_Key in: path description: CallTrackingDiagCodes Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTrackingDiagCodes' text/json: schema: $ref: '#/components/schemas/CallTrackingDiagCodes' application/*+json: schema: $ref: '#/components/schemas/CallTrackingDiagCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingDiagCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingDiagCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingDiagCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - CallTrackingDiagCodes summary: Delete CallTrackingDiagCodes description: Deletes an CallTrackingDiagCodes operationId: DeleteCallTrackingDiagCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CallTrackingDiagCodes_Key in: path description: CallTrackingDiagCodes Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /call-tracking-diag-codes-batch: put: tags: - CallTrackingDiagCodes summary: Create or Update Batch CallTrackingDiagCodes description: 'Create or Update multiple CallTrackingDiagCodes at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCallTrackingDiagCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingDiagCodes' text/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingDiagCodes' application/*+json: schema: type: array items: $ref: '#/components/schemas/CallTrackingDiagCodes' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /call-tracking-proc-codes: post: tags: - CallTrackingProcCodes summary: Create CallTrackingProcCodes description: Creates a new CallTrackingProcCodes operationId: CreateCallTrackingProcCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTrackingProcCodes' text/json: schema: $ref: '#/components/schemas/CallTrackingProcCodes' application/*+json: schema: $ref: '#/components/schemas/CallTrackingProcCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingProcCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingProcCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingProcCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - CallTrackingProcCodes summary: List CallTrackingProcCodes description: Lists all CallTrackingProcCodes operationId: ListCallTrackingProcCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingProcCodesListVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingProcCodesListVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingProcCodesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/call-tracking-proc-codes/{CallTrackingProcCodes_Key}': get: tags: - CallTrackingProcCodes summary: Get CallTrackingProcCodes description: Gets CallTrackingProcCodes operationId: GetCallTrackingProcCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CallTrackingProcCodes_Key in: path description: CallTrackingProcCodes Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingProcCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingProcCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingProcCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - CallTrackingProcCodes summary: Update CallTrackingProcCodes description: Updates a specific CallTrackingProcCodes. operationId: UpdateCallTrackingProcCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CallTrackingProcCodes_Key in: path description: CallTrackingProcCodes Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CallTrackingProcCodes' text/json: schema: $ref: '#/components/schemas/CallTrackingProcCodes' application/*+json: schema: $ref: '#/components/schemas/CallTrackingProcCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingProcCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingProcCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingProcCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - CallTrackingProcCodes summary: Delete CallTrackingProcCodes description: Deletes an CallTrackingProcCodes operationId: DeleteCallTrackingProcCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CallTrackingProcCodes_Key in: path description: CallTrackingProcCodes Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /call-tracking-proc-codes-batch: put: tags: - CallTrackingProcCodes summary: Create or Update Batch CallTrackingProcCodes description: 'Create or Update multiple CallTrackingProcCodes at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCallTrackingProcCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingProcCodes' text/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingProcCodes' application/*+json: schema: type: array items: $ref: '#/components/schemas/CallTrackingProcCodes' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/call-trackings/{callKey}/subscribers/{subscriberID}/members/{memberSeq}': post: tags: - Call Tracking Subscribers summary: Create CallTrackingSubscriber description: Creates a new CallTrackingSubscriber operationId: CreateCallTrackingSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callKey in: path description: Call Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Call Tracking Subscribers summary: Get CallTrackingSubscriber description: Gets CallTrackingSubscriber operationId: GetCallTrackingSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callKey in: path description: Call Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Call Tracking Subscribers summary: Delete CallTrackingSubscriber description: Deletes an CallTrackingSubscriber operationId: DeleteCallTrackingSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callKey in: path description: Call Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/call-trackings/{callKey}/subscribers': get: tags: - Call Tracking Subscribers summary: List CallTrackingSubscriber description: Lists all CallTrackingSubscriber for the given callKey operationId: ListCallTrackingSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callKey in: path description: Call Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CallTrackingSubscriberListVBAResponse' application/json: schema: $ref: '#/components/schemas/CallTrackingSubscriberListVBAResponse' text/json: schema: $ref: '#/components/schemas/CallTrackingSubscriberListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/call-trackings/{callKey}/subscribers-batch': put: tags: - Call Tracking Subscribers summary: Create or Update Batch CallTrackingSubscriber description: 'Create multiple CallTrackingSubscriber at once. If the entity does not exist, it will be created. If the entity does exist, an error code will be returned. Updates are not allowed for this entity.' operationId: UpdateBatchCallTrackingSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: callKey in: path description: Call Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingSubscriber' text/json: schema: type: array items: $ref: '#/components/schemas/CallTrackingSubscriber' application/*+json: schema: type: array items: $ref: '#/components/schemas/CallTrackingSubscriber' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-adjustments: post: tags: - Capitation Adjustments summary: Create CapitationAdjustment description: Creates a new CapitationAdjustment operationId: CreateCapitationAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationAdjustment' text/json: schema: $ref: '#/components/schemas/CapitationAdjustment' application/*+json: schema: $ref: '#/components/schemas/CapitationAdjustment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationAdjustmentVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Capitation Adjustments summary: List CapitationAdjustment description: 'Lists all CapitationAdjustment for the given capitationTransactionKey. If capitationTransactionKey is not provided, a list of Unassigned Capitation Adjustments will be returned.' operationId: ListCapitationAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationTransactionKey in: query description: CapitationTransaction Key schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationAdjustmentListVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentListVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-adjustments/{capitationAdjustmentKey}': get: tags: - Capitation Adjustments summary: Get CapitationAdjustment description: Gets CapitationAdjustment operationId: GetCapitationAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationAdjustmentKey in: path description: CapitationAdjustment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationAdjustmentVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Capitation Adjustments summary: Update CapitationAdjustment description: Updates a specific CapitationAdjustment. operationId: UpdateCapitationAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationAdjustmentKey in: path description: CapitationAdjustment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationAdjustment' text/json: schema: $ref: '#/components/schemas/CapitationAdjustment' application/*+json: schema: $ref: '#/components/schemas/CapitationAdjustment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationAdjustmentVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Capitation Adjustments summary: Delete CapitationAdjustment description: Deletes an CapitationAdjustment operationId: DeleteCapitationAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationAdjustmentKey in: path description: CapitationAdjustment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-adjustments-batch: put: tags: - Capitation Adjustments summary: Create or Update Batch CapitationAdjustment description: 'Create or Update multiple CapitationAdjustment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCapitationAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CapitationAdjustment' text/json: schema: type: array items: $ref: '#/components/schemas/CapitationAdjustment' application/*+json: schema: type: array items: $ref: '#/components/schemas/CapitationAdjustment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-adjustment-reasons: post: tags: - Capitation Adjustment Reasons summary: Create CapitationAdjustmentReason description: Creates a new CapitationAdjustmentReason operationId: CreateCapitationAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentReason' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentReason' application/*+json: schema: $ref: '#/components/schemas/CapitationAdjustmentReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationAdjustmentReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Capitation Adjustment Reasons summary: List CapitationAdjustmentReason description: Lists all CapitationAdjustmentReason operationId: ListCapitationAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationAdjustmentReasonListVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentReasonListVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentReasonListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-adjustment-reasons/{capitationAdjustmentReason}': get: tags: - Capitation Adjustment Reasons summary: Get CapitationAdjustmentReason description: Gets CapitationAdjustmentReason operationId: GetCapitationAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationAdjustmentReason in: path description: Capitation Adjustment Reason required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationAdjustmentReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Capitation Adjustment Reasons summary: Update CapitationAdjustmentReason description: Updates a specific CapitationAdjustmentReason. operationId: UpdateCapitationAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationAdjustmentReason in: path description: Capitation Adjustment Reason required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentReason' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentReason' application/*+json: schema: $ref: '#/components/schemas/CapitationAdjustmentReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationAdjustmentReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Capitation Adjustment Reasons summary: Delete CapitationAdjustmentReason description: Deletes an CapitationAdjustmentReason operationId: DeleteCapitationAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationAdjustmentReason in: path description: Capitation Adjustment Reason required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-adjustment-reasons-batch: put: tags: - Capitation Adjustment Reasons summary: Create or Update Batch CapitationAdjustmentReason description: 'Create or Update multiple CapitationAdjustmentReason at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCapitationAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CapitationAdjustmentReason' text/json: schema: type: array items: $ref: '#/components/schemas/CapitationAdjustmentReason' application/*+json: schema: type: array items: $ref: '#/components/schemas/CapitationAdjustmentReason' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-adjustment-types: post: tags: - Capitation Adjustment Types summary: Create CapitationAdjustmentType description: Creates a new CapitationAdjustmentType operationId: CreateCapitationAdjustmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentType' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentType' application/*+json: schema: $ref: '#/components/schemas/CapitationAdjustmentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationAdjustmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Capitation Adjustment Types summary: List CapitationAdjustmentType description: Lists all CapitationAdjustmentType operationId: ListCapitationAdjustmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationAdjustmentTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-adjustment-types/{capitationAdjustmentType}': get: tags: - Capitation Adjustment Types summary: Get CapitationAdjustmentType description: Gets CapitationAdjustmentType operationId: GetCapitationAdjustmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationAdjustmentType in: path description: Capitation Adjustment Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationAdjustmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Capitation Adjustment Types summary: Update CapitationAdjustmentType description: Updates a specific CapitationAdjustmentType. operationId: UpdateCapitationAdjustmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationAdjustmentType in: path description: Capitation Adjustment Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentType' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentType' application/*+json: schema: $ref: '#/components/schemas/CapitationAdjustmentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationAdjustmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationAdjustmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationAdjustmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Capitation Adjustment Types summary: Delete CapitationAdjustmentType description: Deletes an CapitationAdjustmentType operationId: DeleteCapitationAdjustmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationAdjustmentType in: path description: Capitation Adjustment Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-adjustment-types-batch: put: tags: - Capitation Adjustment Types summary: Create or Update Batch CapitationAdjustmentType description: 'Create or Update multiple CapitationAdjustmentType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCapitationAdjustmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CapitationAdjustmentType' text/json: schema: type: array items: $ref: '#/components/schemas/CapitationAdjustmentType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CapitationAdjustmentType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-categories: post: tags: - Capitation Categories summary: Create CapitationCategory description: Creates a new CapitationCategory operationId: CreateCapitationCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationCategory' text/json: schema: $ref: '#/components/schemas/CapitationCategory' application/*+json: schema: $ref: '#/components/schemas/CapitationCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Capitation Categories summary: List CapitationCategory description: Lists all CapitationCategory operationId: ListCapitationCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-categories/{capitationCategory}': get: tags: - Capitation Categories summary: Get CapitationCategory description: Gets CapitationCategory operationId: GetCapitationCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationCategory in: path description: Capitation Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Capitation Categories summary: Update CapitationCategory description: Updates a specific CapitationCategory. operationId: UpdateCapitationCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationCategory in: path description: Capitation Category required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationCategory' text/json: schema: $ref: '#/components/schemas/CapitationCategory' application/*+json: schema: $ref: '#/components/schemas/CapitationCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Capitation Categories summary: Delete CapitationCategory description: Deletes an CapitationCategory operationId: DeleteCapitationCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationCategory in: path description: Capitation Category required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-categories-batch: put: tags: - Capitation Categories summary: Create or Update Batch CapitationCategory description: 'Create or Update multiple CapitationCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCapitationCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CapitationCategory' text/json: schema: type: array items: $ref: '#/components/schemas/CapitationCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/CapitationCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-categories/{capitationCategory}/capitation-types/{capitationType}': post: tags: - Capitation Category Types summary: Create CapitationCategoryType description: Creates a new CapitationCategoryType operationId: CreateCapitationCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationCategory in: path description: Capitation Category required: true schema: type: string - name: capitationType in: path description: Capitation Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationCategoryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationCategoryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationCategoryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Capitation Category Types summary: Get CapitationCategoryType description: Gets CapitationCategoryType operationId: GetCapitationCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationCategory in: path description: Capitation Category required: true schema: type: string - name: capitationType in: path description: Capitation Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationCategoryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationCategoryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationCategoryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Capitation Category Types summary: Delete CapitationCategoryType description: Deletes an CapitationCategoryType operationId: DeleteCapitationCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationCategory in: path description: Capitation Category required: true schema: type: string - name: capitationType in: path description: Capitation Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-categories/{capitationCategory}/capitation-types': get: tags: - Capitation Category Types summary: List CapitationCategoryType description: Lists all CapitationCategoryType for the given capitationCategory operationId: ListCapitationCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationCategory in: path description: Capitation Category required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationCategoryTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationCategoryTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationCategoryTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-plan-rates: post: tags: - Capitation Plan Rates summary: Create CapitationPlanRate description: Creates a new CapitationPlanRate operationId: CreateCapitationPlanRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationPlanRate' text/json: schema: $ref: '#/components/schemas/CapitationPlanRate' application/*+json: schema: $ref: '#/components/schemas/CapitationPlanRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationPlanRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationPlanRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationPlanRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Capitation Plan Rates summary: List CapitationPlanRate description: Lists all CapitationPlanRate. Supply optinal query parameter planID to filter by a specific plan. operationId: ListCapitationPlanRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: query description: Plan ID schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationPlanRateListVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationPlanRateListVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationPlanRateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-plan-rates/{capitationPlanRateKey}': get: tags: - Capitation Plan Rates summary: Get CapitationPlanRate description: Gets CapitationPlanRate operationId: GetCapitationPlanRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationPlanRateKey in: path description: CapitationPlanRate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationPlanRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationPlanRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationPlanRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Capitation Plan Rates summary: Update CapitationPlanRate description: Updates a specific CapitationPlanRate. operationId: UpdateCapitationPlanRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationPlanRateKey in: path description: CapitationPlanRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationPlanRate' text/json: schema: $ref: '#/components/schemas/CapitationPlanRate' application/*+json: schema: $ref: '#/components/schemas/CapitationPlanRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationPlanRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationPlanRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationPlanRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Capitation Plan Rates summary: Delete CapitationPlanRate description: Deletes an CapitationPlanRate operationId: DeleteCapitationPlanRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationPlanRateKey in: path description: CapitationPlanRate Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-plan-rates-batch: put: tags: - Capitation Plan Rates summary: Create or Update Batch CapitationPlanRate description: 'Create or Update multiple CapitationPlanRate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCapitationPlanRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CapitationPlanRate' text/json: schema: type: array items: $ref: '#/components/schemas/CapitationPlanRate' application/*+json: schema: type: array items: $ref: '#/components/schemas/CapitationPlanRate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-transactions/{capitationTransactionKey}/capitations': post: tags: - Capitations summary: Create Capitation description: Creates a new Capitation operationId: CreateCapitation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationTransactionKey in: path description: CapitationTransaction Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Capitation' text/json: schema: $ref: '#/components/schemas/Capitation' application/*+json: schema: $ref: '#/components/schemas/Capitation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Capitations summary: List Capitation description: Lists all Capitation for the given capitationTransactionKey operationId: ListCapitation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationTransactionKey in: path description: CapitationTransaction Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationListVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationListVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /unassigned-capitations: get: tags: - Capitations summary: List Unassigned Capitation description: Lists all Capitation that is currently not assigned to a Capitation Transaction operationId: ListUnassignedCapitation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationListVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationListVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-transactions/{capitationTransactionKey}/capitations/{capitationKey}': get: tags: - Capitations summary: Get Capitation description: Gets Capitation operationId: GetCapitation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationTransactionKey in: path description: CapitationTransaction Key required: true schema: type: integer format: int32 - name: capitationKey in: path description: Capitation Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Capitations summary: Update Capitation description: Updates a specific Capitation. operationId: UpdateCapitation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationTransactionKey in: path description: CapitationTransaction Key required: true schema: type: integer format: int32 - name: capitationKey in: path description: Capitation Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Capitation' text/json: schema: $ref: '#/components/schemas/Capitation' application/*+json: schema: $ref: '#/components/schemas/Capitation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Capitations summary: Delete Capitation description: Deletes an Capitation operationId: DeleteCapitation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationTransactionKey in: path description: CapitationTransaction Key required: true schema: type: integer format: int32 - name: capitationKey in: path description: Capitation Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-generate: post: tags: - Capitations - Adv. Capitation summary: Capitation Generate description: Generates Capitation records and attaches those to a new Capitation Transaction based on entered criteria. operationId: CapitationGenerate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationGenerate' text/json: schema: $ref: '#/components/schemas/CapitationGenerate' application/*+json: schema: $ref: '#/components/schemas/CapitationGenerate' required: true responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /capitation-generate-set-unassigned: post: tags: - Capitations - Adv. Capitation summary: Capitation Generate Set Unassigned description: Takes existing unassigned capitation records and attaches them to the chosen Provider on a newly created Capitation Transaction. operationId: CapitationGenerateSetUnassigned parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationGenerate' text/json: schema: $ref: '#/components/schemas/CapitationGenerate' application/*+json: schema: $ref: '#/components/schemas/CapitationGenerate' required: true responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /capitation-generate-assign: post: tags: - Capitations - Adv. Capitation summary: Capitation Generate Assign description: 'Takes selected unassigned list of CapitationKeys and a valid Payee, and attaches them to a newly created Capitation Transaction.' operationId: CapitationGenerateAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationGenerate' text/json: schema: $ref: '#/components/schemas/CapitationGenerate' application/*+json: schema: $ref: '#/components/schemas/CapitationGenerate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationTransactionVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationTransactionVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationTransactionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/capitation-transactions/{capitationTransactionKey}/capitations-batch': put: tags: - Capitations summary: Create or Update Batch Capitation description: 'Create or Update multiple Capitation at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCapitation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationTransactionKey in: path description: CapitationTransaction Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Capitation' text/json: schema: type: array items: $ref: '#/components/schemas/Capitation' application/*+json: schema: type: array items: $ref: '#/components/schemas/Capitation' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-services: post: tags: - Capitation Services summary: Create CapitationService description: Creates a new CapitationService operationId: CreateCapitationService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationService' text/json: schema: $ref: '#/components/schemas/CapitationService' application/*+json: schema: $ref: '#/components/schemas/CapitationService' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationServiceVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationServiceVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationServiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Capitation Services summary: List CapitationService description: Lists all CapitationService operationId: ListCapitationService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationServiceListVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationServiceListVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationServiceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-services/{capitationServiceKey}': get: tags: - Capitation Services summary: Get CapitationService description: Gets CapitationService operationId: GetCapitationService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationServiceVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationServiceVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationServiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Capitation Services summary: Update CapitationService description: Updates a specific CapitationService. operationId: UpdateCapitationService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationService' text/json: schema: $ref: '#/components/schemas/CapitationService' application/*+json: schema: $ref: '#/components/schemas/CapitationService' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationServiceVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationServiceVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationServiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Capitation Services summary: Delete CapitationService description: Deletes an CapitationService operationId: DeleteCapitationService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-services-batch: put: tags: - Capitation Services summary: Create or Update Batch CapitationService description: 'Create or Update multiple CapitationService at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCapitationService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CapitationService' text/json: schema: type: array items: $ref: '#/components/schemas/CapitationService' application/*+json: schema: type: array items: $ref: '#/components/schemas/CapitationService' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-services/{capitationServiceKey}/capitation-service-plans/{planID}': post: tags: - Capitation Service Plans summary: Create CapitationServicePlan description: Creates a new CapitationServicePlan operationId: CreateCapitationServicePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationServicePlan' text/json: schema: $ref: '#/components/schemas/CapitationServicePlan' application/*+json: schema: $ref: '#/components/schemas/CapitationServicePlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationServicePlanVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationServicePlanVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationServicePlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Capitation Service Plans summary: Get CapitationServicePlan description: Gets CapitationServicePlan operationId: GetCapitationServicePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationServicePlanVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationServicePlanVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationServicePlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Capitation Service Plans summary: Update CapitationServicePlan description: Updates a specific CapitationServicePlan. operationId: UpdateCapitationServicePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationServicePlan' text/json: schema: $ref: '#/components/schemas/CapitationServicePlan' application/*+json: schema: $ref: '#/components/schemas/CapitationServicePlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationServicePlanVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationServicePlanVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationServicePlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Capitation Service Plans summary: Delete CapitationServicePlan description: Deletes an CapitationServicePlan operationId: DeleteCapitationServicePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-services/{capitationServiceKey}/capitation-service-plans': get: tags: - Capitation Service Plans summary: List CapitationServicePlan description: Lists all CapitationServicePlan for the given capitationServiceKey operationId: ListCapitationServicePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationServicePlanListVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationServicePlanListVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationServicePlanListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-services/{capitationServiceKey}/capitation-service-plans-batch': put: tags: - Capitation Service Plans summary: Create or Update Batch CapitationServicePlan description: 'Create or Update multiple CapitationServicePlan at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCapitationServicePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CapitationServicePlan' text/json: schema: type: array items: $ref: '#/components/schemas/CapitationServicePlan' application/*+json: schema: type: array items: $ref: '#/components/schemas/CapitationServicePlan' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-services/{capitationServiceKey}/capitation-service-tax-ids/{federalID}': post: tags: - Capitation Service Tax IDs summary: Create CapitationServiceTIN description: Creates a new CapitationServiceTIN operationId: CreateCapitationServiceTIN parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 - name: federalID in: path description: Federal ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationServiceTIN' text/json: schema: $ref: '#/components/schemas/CapitationServiceTIN' application/*+json: schema: $ref: '#/components/schemas/CapitationServiceTIN' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationServiceTINVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationServiceTINVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationServiceTINVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Capitation Service Tax IDs summary: Get CapitationServiceTIN description: Gets CapitationServiceTIN operationId: GetCapitationServiceTIN parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 - name: federalID in: path description: Federal ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationServiceTINVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationServiceTINVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationServiceTINVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Capitation Service Tax IDs summary: Update CapitationServiceTIN description: Updates a specific CapitationServiceTIN. operationId: UpdateCapitationServiceTIN parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 - name: federalID in: path description: Federal ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationServiceTIN' text/json: schema: $ref: '#/components/schemas/CapitationServiceTIN' application/*+json: schema: $ref: '#/components/schemas/CapitationServiceTIN' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationServiceTINVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationServiceTINVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationServiceTINVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Capitation Service Tax IDs summary: Delete CapitationServiceTIN description: Deletes an CapitationServiceTIN operationId: DeleteCapitationServiceTIN parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 - name: federalID in: path description: Federal ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-services/{capitationServiceKey}/capitation-service-tax-ids': get: tags: - Capitation Service Tax IDs summary: List CapitationServiceTIN description: Lists all CapitationServiceTIN for the given capitationServiceKey operationId: ListCapitationServiceTIN parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationServiceTINListVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationServiceTINListVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationServiceTINListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-services/{capitationServiceKey}/capitation-service-tax-ids-batch': put: tags: - Capitation Service Tax IDs summary: Create or Update Batch CapitationServiceTIN description: 'Create or Update multiple CapitationServiceTIN at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCapitationServiceTIN parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationServiceKey in: path description: CapitationService Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CapitationServiceTIN' text/json: schema: type: array items: $ref: '#/components/schemas/CapitationServiceTIN' application/*+json: schema: type: array items: $ref: '#/components/schemas/CapitationServiceTIN' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-transactions: post: tags: - Capitation Transactions summary: Create CapitationTransaction description: Creates a new CapitationTransaction operationId: CreateCapitationTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationTransaction' text/json: schema: $ref: '#/components/schemas/CapitationTransaction' application/*+json: schema: $ref: '#/components/schemas/CapitationTransaction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationTransactionVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationTransactionVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationTransactionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Capitation Transactions summary: List CapitationTransaction description: Lists all CapitationTransaction operationId: ListCapitationTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationTransactionListVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationTransactionListVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationTransactionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-transactions/{capitationTransactionKey}': get: tags: - Capitation Transactions summary: Get CapitationTransaction description: Gets CapitationTransaction operationId: GetCapitationTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationTransactionKey in: path description: CapitationTransaction Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationTransactionVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationTransactionVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationTransactionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Capitation Transactions summary: Update CapitationTransaction description: Updates a specific CapitationTransaction. operationId: UpdateCapitationTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationTransactionKey in: path description: CapitationTransaction Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationTransaction' text/json: schema: $ref: '#/components/schemas/CapitationTransaction' application/*+json: schema: $ref: '#/components/schemas/CapitationTransaction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationTransactionVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationTransactionVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationTransactionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Capitation Transactions summary: Delete CapitationTransaction description: Deletes an CapitationTransaction operationId: DeleteCapitationTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationTransactionKey in: path description: CapitationTransaction Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-transactions-batch: put: tags: - Capitation Transactions summary: Create or Update Batch CapitationTransaction description: 'Create or Update multiple CapitationTransaction at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCapitationTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CapitationTransaction' text/json: schema: type: array items: $ref: '#/components/schemas/CapitationTransaction' application/*+json: schema: type: array items: $ref: '#/components/schemas/CapitationTransaction' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-types: post: tags: - Capitation Types summary: Create CapitationType description: Creates a new CapitationType operationId: CreateCapitationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationType' text/json: schema: $ref: '#/components/schemas/CapitationType' application/*+json: schema: $ref: '#/components/schemas/CapitationType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Capitation Types summary: List CapitationType description: Lists all CapitationType operationId: ListCapitationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/capitation-types/{capitationType}': get: tags: - Capitation Types summary: Get CapitationType description: Gets CapitationType operationId: GetCapitationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationType in: path description: Capitation Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Capitation Types summary: Update CapitationType description: Updates a specific CapitationType. operationId: UpdateCapitationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationType in: path description: Capitation Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitationType' text/json: schema: $ref: '#/components/schemas/CapitationType' application/*+json: schema: $ref: '#/components/schemas/CapitationType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CapitationTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CapitationTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CapitationTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Capitation Types summary: Delete CapitationType description: Deletes an CapitationType operationId: DeleteCapitationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: capitationType in: path description: Capitation Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /capitation-types-batch: put: tags: - Capitation Types summary: Create or Update Batch CapitationType description: 'Create or Update multiple CapitationType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCapitationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CapitationType' text/json: schema: type: array items: $ref: '#/components/schemas/CapitationType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CapitationType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/cases': post: tags: - Care Cases summary: Create CareCase description: Creates a new CareCase operationId: CreateCareCase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCase' text/json: schema: $ref: '#/components/schemas/CareCase' application/*+json: schema: $ref: '#/components/schemas/CareCase' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Cases summary: List CareCase description: Lists all CareCase for the given carePlanKey operationId: ListCareCase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/cases/{caseKey}': get: tags: - Care Cases summary: Get CareCase description: Gets CareCase operationId: GetCareCase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Cases summary: Update CareCase description: Updates a specific CareCase. operationId: UpdateCareCase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCase' text/json: schema: $ref: '#/components/schemas/CareCase' application/*+json: schema: $ref: '#/components/schemas/CareCase' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Cases summary: Delete CareCase description: Deletes an CareCase operationId: DeleteCareCase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/cases-batch': put: tags: - Care Cases summary: Create or Update Batch CareCase description: 'Create or Update multiple CareCase at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCase' text/json: schema: type: array items: $ref: '#/components/schemas/CareCase' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCase' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/actions': post: tags: - Care Case Actions summary: Create CareCaseAction description: Creates a new CareCaseAction operationId: CreateCareCaseAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseAction' text/json: schema: $ref: '#/components/schemas/CareCaseAction' application/*+json: schema: $ref: '#/components/schemas/CareCaseAction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseActionVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseActionVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseActionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Actions summary: List CareCaseAction description: Lists all CareCaseAction for the given caseKey operationId: ListCareCaseAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseActionListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseActionListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseActionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/actions/{careCaseActionKey}': get: tags: - Care Case Actions summary: Get CareCaseAction description: Gets CareCaseAction operationId: GetCareCaseAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseActionKey in: path description: CareCaseAction Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseActionVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseActionVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseActionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Actions summary: Update CareCaseAction description: Updates a specific CareCaseAction. operationId: UpdateCareCaseAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseActionKey in: path description: CareCaseAction Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseAction' text/json: schema: $ref: '#/components/schemas/CareCaseAction' application/*+json: schema: $ref: '#/components/schemas/CareCaseAction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseActionVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseActionVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseActionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Actions summary: Delete CareCaseAction description: Deletes an CareCaseAction operationId: DeleteCareCaseAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseActionKey in: path description: CareCaseAction Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/actions-batch': put: tags: - Care Case Actions summary: Create or Update Batch CareCaseAction description: 'Create or Update multiple CareCaseAction at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseAction' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseAction' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseAction' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/authorizations': post: tags: - Care Case Authorizations summary: Create CareCaseAuth description: Creates a new CareCaseAuth operationId: CreateCareCaseAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseAuth' text/json: schema: $ref: '#/components/schemas/CareCaseAuth' application/*+json: schema: $ref: '#/components/schemas/CareCaseAuth' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseAuthVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseAuthVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseAuthVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Authorizations summary: List CareCaseAuth description: Lists all CareCaseAuth for the given caseKey operationId: ListCareCaseAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseAuthListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseAuthListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseAuthListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/authorizations/{careCaseAuthKey}': get: tags: - Care Case Authorizations summary: Get CareCaseAuth description: Gets CareCaseAuth operationId: GetCareCaseAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseAuthKey in: path description: CareCaseAuth Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseAuthVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseAuthVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseAuthVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Authorizations summary: Update CareCaseAuth description: Updates a specific CareCaseAuth. operationId: UpdateCareCaseAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseAuthKey in: path description: CareCaseAuth Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseAuth' text/json: schema: $ref: '#/components/schemas/CareCaseAuth' application/*+json: schema: $ref: '#/components/schemas/CareCaseAuth' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseAuthVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseAuthVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseAuthVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Authorizations summary: Delete CareCaseAuth description: Deletes an CareCaseAuth operationId: DeleteCareCaseAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseAuthKey in: path description: CareCaseAuth Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/authorizations-batch': put: tags: - Care Case Authorizations summary: Create or Update Batch CareCaseAuth description: 'Create or Update multiple CareCaseAuth at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseAuth' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseAuth' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseAuth' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-clinical-fact-categories/{careCaseClinicalFactCategory}/types/{careCaseClinicalFactCategoryType}/facts': post: tags: - Care Case Clinical Facts summary: Create CareCaseClinicalFact description: Creates a new CareCaseClinicalFact operationId: CreateCareCaseClinicalFact parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory required: true schema: type: string - name: careCaseClinicalFactCategoryType in: path description: CareCaseClinicalFactCategoryType required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFact' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFact' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalFact' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalFactVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Clinical Facts summary: List CareCaseClinicalFact description: Lists all CareCaseClinicalFact for the given careCaseClinicalFactCategory and careCaseClinicalFactCategoryType operationId: ListCareCaseClinicalFact parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory required: true schema: type: string - name: careCaseClinicalFactCategoryType in: path description: CareCaseClinicalFactCategoryType required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalFactListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-clinical-fact-categories/{careCaseClinicalFactCategory}/types/{careCaseClinicalFactCategoryType}/facts/{careCaseClinicalFactKey}': get: tags: - Care Case Clinical Facts summary: Get CareCaseClinicalFact description: Gets CareCaseClinicalFact operationId: GetCareCaseClinicalFact parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory required: true schema: type: string - name: careCaseClinicalFactCategoryType in: path description: CareCaseClinicalFactCategoryType required: true schema: type: string - name: careCaseClinicalFactKey in: path description: CareCaseClinicalFact Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalFactVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Clinical Facts summary: Update CareCaseClinicalFact description: Updates a specific CareCaseClinicalFact. operationId: UpdateCareCaseClinicalFact parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory required: true schema: type: string - name: careCaseClinicalFactCategoryType in: path description: CareCaseClinicalFactCategoryType required: true schema: type: string - name: careCaseClinicalFactKey in: path description: CareCaseClinicalFact Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFact' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFact' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalFact' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalFactVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Clinical Facts summary: Delete CareCaseClinicalFact description: Deletes an CareCaseClinicalFact operationId: DeleteCareCaseClinicalFact parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory required: true schema: type: string - name: careCaseClinicalFactCategoryType in: path description: CareCaseClinicalFactCategoryType required: true schema: type: string - name: careCaseClinicalFactKey in: path description: CareCaseClinicalFact Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-clinical-fact-categories/{careCaseClinicalFactCategory}/types/{careCaseClinicalFactCategoryType}/facts-batch': put: tags: - Care Case Clinical Facts summary: Create or Update Batch CareCaseClinicalFact description: 'Create or Update multiple CareCaseClinicalFact at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseClinicalFact parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory required: true schema: type: string - name: careCaseClinicalFactCategoryType in: path description: CareCaseClinicalFactCategoryType required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalFact' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalFact' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalFact' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-clinical-fact-categories: post: tags: - Care Case Clinical Fact Categories summary: Create CareCaseClinicalFactCategory description: Creates a new CareCaseClinicalFactCategory operationId: CreateCareCaseClinicalFactCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategory' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategory' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Clinical Fact Categories summary: List CareCaseClinicalFactCategory description: Lists all CareCaseClinicalFactCategory operationId: ListCareCaseClinicalFactCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-clinical-fact-categories/{careCaseClinicalFactCategory}': get: tags: - Care Case Clinical Fact Categories summary: Get CareCaseClinicalFactCategory description: Gets CareCaseClinicalFactCategory operationId: GetCareCaseClinicalFactCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory1 required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Clinical Fact Categories summary: Update CareCaseClinicalFactCategory description: Updates a specific CareCaseClinicalFactCategory. operationId: UpdateCareCaseClinicalFactCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory1 required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategory' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategory' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Clinical Fact Categories summary: Delete CareCaseClinicalFactCategory description: Deletes an CareCaseClinicalFactCategory operationId: DeleteCareCaseClinicalFactCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory1 required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-clinical-fact-categories-batch: put: tags: - Care Case Clinical Fact Categories summary: Create or Update Batch CareCaseClinicalFactCategory description: 'Create or Update multiple CareCaseClinicalFactCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseClinicalFactCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalFactCategory' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalFactCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalFactCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-clinical-fact-categories/{careCaseClinicalFactCategory}/types': post: tags: - Care Case Clinical Fact Category Types summary: Create CareCaseClinicalFactCategoryType description: Creates a new CareCaseClinicalFactCategoryType operationId: CreateCareCaseClinicalFactCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryType' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryType' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Clinical Fact Category Types summary: List CareCaseClinicalFactCategoryType description: Lists all CareCaseClinicalFactCategoryType for the given careCaseClinicalFactCategory operationId: ListCareCaseClinicalFactCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-clinical-fact-categories/{careCaseClinicalFactCategory}/types/{careCaseClinicalFactCategoryType}': get: tags: - Care Case Clinical Fact Category Types summary: Get CareCaseClinicalFactCategoryType description: Gets CareCaseClinicalFactCategoryType operationId: GetCareCaseClinicalFactCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory required: true schema: type: string - name: careCaseClinicalFactCategoryType in: path description: CareCaseClinicalFactCategoryType1 required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Clinical Fact Category Types summary: Update CareCaseClinicalFactCategoryType description: Updates a specific CareCaseClinicalFactCategoryType. operationId: UpdateCareCaseClinicalFactCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory required: true schema: type: string - name: careCaseClinicalFactCategoryType in: path description: CareCaseClinicalFactCategoryType1 required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryType' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryType' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalFactCategoryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Clinical Fact Category Types summary: Delete CareCaseClinicalFactCategoryType description: Deletes an CareCaseClinicalFactCategoryType operationId: DeleteCareCaseClinicalFactCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory required: true schema: type: string - name: careCaseClinicalFactCategoryType in: path description: CareCaseClinicalFactCategoryType1 required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-clinical-fact-categories/{careCaseClinicalFactCategory}/types-batch': put: tags: - Care Case Clinical Fact Category Types summary: Create or Update Batch CareCaseClinicalFactCategoryType description: 'Create or Update multiple CareCaseClinicalFactCategoryType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseClinicalFactCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalFactCategory in: path description: CareCaseClinicalFactCategory required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalFactCategoryType' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalFactCategoryType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalFactCategoryType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-clinical-trials: post: tags: - Care Case Clinical Trials summary: Create CareCaseClinicalTrial description: Creates a new CareCaseClinicalTrial operationId: CreateCareCaseClinicalTrial parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrial' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrial' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalTrial' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Clinical Trials summary: List CareCaseClinicalTrial description: Lists all CareCaseClinicalTrial operationId: ListCareCaseClinicalTrial parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-clinical-trials/{CareCaseClinicalTrial_Key}': get: tags: - Care Case Clinical Trials summary: Get CareCaseClinicalTrial description: Gets CareCaseClinicalTrial operationId: GetCareCaseClinicalTrial parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CareCaseClinicalTrial_Key in: path description: CareCaseClinicalTrial Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Clinical Trials summary: Update CareCaseClinicalTrial description: Updates a specific CareCaseClinicalTrial. operationId: UpdateCareCaseClinicalTrial parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CareCaseClinicalTrial_Key in: path description: CareCaseClinicalTrial Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrial' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrial' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalTrial' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Clinical Trials summary: Delete CareCaseClinicalTrial description: Deletes an CareCaseClinicalTrial operationId: DeleteCareCaseClinicalTrial parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CareCaseClinicalTrial_Key in: path description: CareCaseClinicalTrial Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-clinical-trials-batch: put: tags: - Care Case Clinical Trials summary: Create or Update Batch CareCaseClinicalTrial description: 'Create or Update multiple CareCaseClinicalTrial at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseClinicalTrial parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrial' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrial' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrial' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-clinical-trial-arms: post: tags: - Care Case Clinical Trial Arms summary: Create CareCaseClinicalTrialArm description: Creates a new CareCaseClinicalTrialArm operationId: CreateCareCaseClinicalTrialArm parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArm' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArm' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArm' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArmVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArmVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArmVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Clinical Trial Arms summary: List CareCaseClinicalTrialArm description: Lists all CareCaseClinicalTrialArm operationId: ListCareCaseClinicalTrialArm parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArmListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArmListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArmListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-clinical-trial-arms/{careCaseClinicalTrialArmID}': get: tags: - Care Case Clinical Trial Arms summary: Get CareCaseClinicalTrialArm description: Gets CareCaseClinicalTrialArm operationId: GetCareCaseClinicalTrialArm parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalTrialArmID in: path description: CareCaseClinicalTrialArm ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArmVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArmVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArmVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Clinical Trial Arms summary: Update CareCaseClinicalTrialArm description: Updates a specific CareCaseClinicalTrialArm. operationId: UpdateCareCaseClinicalTrialArm parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalTrialArmID in: path description: CareCaseClinicalTrialArm ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArm' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArm' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArm' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArmVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArmVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialArmVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Clinical Trial Arms summary: Delete CareCaseClinicalTrialArm description: Deletes an CareCaseClinicalTrialArm operationId: DeleteCareCaseClinicalTrialArm parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalTrialArmID in: path description: CareCaseClinicalTrialArm ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-clinical-trial-arms-batch: put: tags: - Care Case Clinical Trial Arms summary: Create or Update Batch CareCaseClinicalTrialArm description: 'Create or Update multiple CareCaseClinicalTrialArm at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseClinicalTrialArm parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrialArm' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrialArm' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrialArm' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-clinical-trial-reasons: post: tags: - Care Case Clinical Trial Reasons summary: Create CareCaseClinicalTrialReason description: Creates a new CareCaseClinicalTrialReason operationId: CreateCareCaseClinicalTrialReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReason' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReason' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Clinical Trial Reasons summary: List CareCaseClinicalTrialReason description: Lists all CareCaseClinicalTrialReason operationId: ListCareCaseClinicalTrialReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReasonListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReasonListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReasonListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-clinical-trial-reasons/{careCaseClinicalTrialReasonID}': get: tags: - Care Case Clinical Trial Reasons summary: Get CareCaseClinicalTrialReason description: Gets CareCaseClinicalTrialReason operationId: GetCareCaseClinicalTrialReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalTrialReasonID in: path description: CareCaseClinicalTrialReason ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Clinical Trial Reasons summary: Update CareCaseClinicalTrialReason description: Updates a specific CareCaseClinicalTrialReason. operationId: UpdateCareCaseClinicalTrialReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalTrialReasonID in: path description: CareCaseClinicalTrialReason ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReason' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReason' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Clinical Trial Reasons summary: Delete CareCaseClinicalTrialReason description: Deletes an CareCaseClinicalTrialReason operationId: DeleteCareCaseClinicalTrialReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalTrialReasonID in: path description: CareCaseClinicalTrialReason ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-clinical-trial-reasons-batch: put: tags: - Care Case Clinical Trial Reasons summary: Create or Update Batch CareCaseClinicalTrialReason description: 'Create or Update multiple CareCaseClinicalTrialReason at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseClinicalTrialReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrialReason' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrialReason' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrialReason' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-clinical-trial-study-phases: post: tags: - Care Case Clinical Trial Study Phases summary: Create CareCaseClinicalTrialStudyPhase description: Creates a new CareCaseClinicalTrialStudyPhase operationId: CreateCareCaseClinicalTrialStudyPhase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhase' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhase' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhase' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhaseVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhaseVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhaseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Clinical Trial Study Phases summary: List CareCaseClinicalTrialStudyPhase description: Lists all CareCaseClinicalTrialStudyPhase operationId: ListCareCaseClinicalTrialStudyPhase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhaseListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhaseListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhaseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-clinical-trial-study-phases/{careCaseClinicalTrialStudyPhaseID}': get: tags: - Care Case Clinical Trial Study Phases summary: Get CareCaseClinicalTrialStudyPhase description: Gets CareCaseClinicalTrialStudyPhase operationId: GetCareCaseClinicalTrialStudyPhase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalTrialStudyPhaseID in: path description: CareCaseClinicalTrialStudyPhase ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhaseVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhaseVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhaseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Clinical Trial Study Phases summary: Update CareCaseClinicalTrialStudyPhase description: Updates a specific CareCaseClinicalTrialStudyPhase. operationId: UpdateCareCaseClinicalTrialStudyPhase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalTrialStudyPhaseID in: path description: CareCaseClinicalTrialStudyPhase ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhase' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhase' application/*+json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhase' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhaseVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhaseVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhaseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Clinical Trial Study Phases summary: Delete CareCaseClinicalTrialStudyPhase description: Deletes an CareCaseClinicalTrialStudyPhase operationId: DeleteCareCaseClinicalTrialStudyPhase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseClinicalTrialStudyPhaseID in: path description: CareCaseClinicalTrialStudyPhase ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-clinical-trial-study-phases-batch: put: tags: - Care Case Clinical Trial Study Phases summary: Create or Update Batch CareCaseClinicalTrialStudyPhase description: 'Create or Update multiple CareCaseClinicalTrialStudyPhase at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseClinicalTrialStudyPhase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhase' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhase' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhase' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/compliances': post: tags: - Care Case Compliances summary: Create CareCaseCompliance description: Creates a new CareCaseCompliance operationId: CreateCareCaseCompliance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseCompliance' text/json: schema: $ref: '#/components/schemas/CareCaseCompliance' application/*+json: schema: $ref: '#/components/schemas/CareCaseCompliance' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseComplianceVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseComplianceVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseComplianceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Compliances summary: List CareCaseCompliance description: Lists all CareCaseCompliance for the given caseKey operationId: ListCareCaseCompliance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseComplianceListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseComplianceListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseComplianceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/compliances/{careCaseComplianceKey}': get: tags: - Care Case Compliances summary: Get CareCaseCompliance description: Gets CareCaseCompliance operationId: GetCareCaseCompliance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseComplianceKey in: path description: CareCaseCompliance Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseComplianceVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseComplianceVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseComplianceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Compliances summary: Update CareCaseCompliance description: Updates a specific CareCaseCompliance. operationId: UpdateCareCaseCompliance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseComplianceKey in: path description: CareCaseCompliance Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseCompliance' text/json: schema: $ref: '#/components/schemas/CareCaseCompliance' application/*+json: schema: $ref: '#/components/schemas/CareCaseCompliance' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseComplianceVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseComplianceVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseComplianceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Compliances summary: Delete CareCaseCompliance description: Deletes an CareCaseCompliance operationId: DeleteCareCaseCompliance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseComplianceKey in: path description: CareCaseCompliance Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/compliances-batch': put: tags: - Care Case Compliances summary: Create or Update Batch CareCaseCompliance description: 'Create or Update multiple CareCaseCompliance at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseCompliance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseCompliance' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseCompliance' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseCompliance' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /concordances: post: tags: - Care Case Concordances summary: Create CareCaseConcordance description: Creates a new CareCaseConcordance operationId: CreateCareCaseConcordance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseConcordance' text/json: schema: $ref: '#/components/schemas/CareCaseConcordance' application/*+json: schema: $ref: '#/components/schemas/CareCaseConcordance' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseConcordanceVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseConcordanceVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseConcordanceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Concordances summary: List CareCaseConcordance description: Lists all CareCaseConcordance operationId: ListCareCaseConcordance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseConcordanceListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseConcordanceListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseConcordanceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/concordances/{careCaseConcordanceKey}': get: tags: - Care Case Concordances summary: Get CareCaseConcordance description: Gets CareCaseConcordance operationId: GetCareCaseConcordance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseConcordanceKey in: path description: CareCaseConcordance Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseConcordanceVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseConcordanceVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseConcordanceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Concordances summary: Update CareCaseConcordance description: Updates a specific CareCaseConcordance. operationId: UpdateCareCaseConcordance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseConcordanceKey in: path description: CareCaseConcordance Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseConcordance' text/json: schema: $ref: '#/components/schemas/CareCaseConcordance' application/*+json: schema: $ref: '#/components/schemas/CareCaseConcordance' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseConcordanceVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseConcordanceVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseConcordanceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Concordances summary: Delete CareCaseConcordance description: Deletes an CareCaseConcordance operationId: DeleteCareCaseConcordance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseConcordanceKey in: path description: CareCaseConcordance Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /concordances-batch: put: tags: - Care Case Concordances summary: Create or Update Batch CareCaseConcordance description: 'Create or Update multiple CareCaseConcordance at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseConcordance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseConcordance' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseConcordance' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseConcordance' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/details': post: tags: - Care Case Details summary: Create CareCaseDetail description: Creates a new CareCaseDetail operationId: CreateCareCaseDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseDetail' text/json: schema: $ref: '#/components/schemas/CareCaseDetail' application/*+json: schema: $ref: '#/components/schemas/CareCaseDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Details summary: List CareCaseDetail description: Lists all CareCaseDetail for the given caseKey operationId: ListCareCaseDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/details/{caseDetailKey}': get: tags: - Care Case Details summary: Get CareCaseDetail description: Gets CareCaseDetail operationId: GetCareCaseDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: caseDetailKey in: path description: CaseDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Details summary: Update CareCaseDetail description: Updates a specific CareCaseDetail. operationId: UpdateCareCaseDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: caseDetailKey in: path description: CaseDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseDetail' text/json: schema: $ref: '#/components/schemas/CareCaseDetail' application/*+json: schema: $ref: '#/components/schemas/CareCaseDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Details summary: Delete CareCaseDetail description: Deletes an CareCaseDetail operationId: DeleteCareCaseDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: caseDetailKey in: path description: CaseDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/details-batch': put: tags: - Care Case Details summary: Create or Update Batch CareCaseDetail description: 'Create or Update multiple CareCaseDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseDetail' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/diagnoses': post: tags: - Care Case Diagnoses summary: Create CareCaseDiagnosis description: Creates a new CareCaseDiagnosis operationId: CreateCareCaseDiagnosis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseDiagnosis' text/json: schema: $ref: '#/components/schemas/CareCaseDiagnosis' application/*+json: schema: $ref: '#/components/schemas/CareCaseDiagnosis' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseDiagnosisVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseDiagnosisVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseDiagnosisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Diagnoses summary: List CareCaseDiagnosis description: Lists all CareCaseDiagnosis for the given caseKey operationId: ListCareCaseDiagnosis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseDiagnosisListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseDiagnosisListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseDiagnosisListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/diagnoses/{careCaseDiagnosisKey}': get: tags: - Care Case Diagnoses summary: Get CareCaseDiagnosis description: Gets CareCaseDiagnosis operationId: GetCareCaseDiagnosis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseDiagnosisKey in: path description: CareCaseDiagnosis Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseDiagnosisVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseDiagnosisVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseDiagnosisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Diagnoses summary: Update CareCaseDiagnosis description: Updates a specific CareCaseDiagnosis. operationId: UpdateCareCaseDiagnosis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseDiagnosisKey in: path description: CareCaseDiagnosis Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseDiagnosis' text/json: schema: $ref: '#/components/schemas/CareCaseDiagnosis' application/*+json: schema: $ref: '#/components/schemas/CareCaseDiagnosis' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseDiagnosisVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseDiagnosisVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseDiagnosisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Diagnoses summary: Delete CareCaseDiagnosis description: Deletes an CareCaseDiagnosis operationId: DeleteCareCaseDiagnosis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseDiagnosisKey in: path description: CareCaseDiagnosis Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/diagnoses-batch': put: tags: - Care Case Diagnoses summary: Create or Update Batch CareCaseDiagnosis description: 'Create or Update multiple CareCaseDiagnosis at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseDiagnosis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseDiagnosis' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseDiagnosis' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseDiagnosis' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-eligibility-statuses: post: tags: - Care Case Eligibility Statuses summary: Create CareCaseEligibilityStatus description: Creates a new CareCaseEligibilityStatus operationId: CreateCareCaseEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatus' text/json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatus' application/*+json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseEligibilityStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Eligibility Statuses summary: List CareCaseEligibilityStatus description: Lists all CareCaseEligibilityStatus operationId: ListCareCaseEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseEligibilityStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-eligibility-statuses/{careCaseEligibilityStatusID}': get: tags: - Care Case Eligibility Statuses summary: Get CareCaseEligibilityStatus description: Gets CareCaseEligibilityStatus operationId: GetCareCaseEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseEligibilityStatusID in: path description: CareCaseEligibilityStatus ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseEligibilityStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Eligibility Statuses summary: Update CareCaseEligibilityStatus description: Updates a specific CareCaseEligibilityStatus. operationId: UpdateCareCaseEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseEligibilityStatusID in: path description: CareCaseEligibilityStatus ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatus' text/json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatus' application/*+json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseEligibilityStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseEligibilityStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Eligibility Statuses summary: Delete CareCaseEligibilityStatus description: Deletes an CareCaseEligibilityStatus operationId: DeleteCareCaseEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseEligibilityStatusID in: path description: CareCaseEligibilityStatus ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-eligibility-statuses-batch: put: tags: - Care Case Eligibility Statuses summary: Create or Update Batch CareCaseEligibilityStatus description: 'Create or Update multiple CareCaseEligibilityStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseEligibilityStatus' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseEligibilityStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseEligibilityStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /emetic-risks: post: tags: - Care Case Emetic Risks summary: Create CareCaseEmeticRisk description: Creates a new CareCaseEmeticRisk operationId: CreateCareCaseEmeticRisk parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseEmeticRisk' text/json: schema: $ref: '#/components/schemas/CareCaseEmeticRisk' application/*+json: schema: $ref: '#/components/schemas/CareCaseEmeticRisk' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseEmeticRiskVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseEmeticRiskVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseEmeticRiskVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Emetic Risks summary: List CareCaseEmeticRisk description: Lists all CareCaseEmeticRisk operationId: ListCareCaseEmeticRisk parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseEmeticRiskListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseEmeticRiskListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseEmeticRiskListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/emetic-risks/{careCaseEmeticRiskKey}': get: tags: - Care Case Emetic Risks summary: Get CareCaseEmeticRisk description: Gets CareCaseEmeticRisk operationId: GetCareCaseEmeticRisk parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseEmeticRiskKey in: path description: CareCaseEmeticRisk Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseEmeticRiskVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseEmeticRiskVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseEmeticRiskVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Emetic Risks summary: Update CareCaseEmeticRisk description: Updates a specific CareCaseEmeticRisk. operationId: UpdateCareCaseEmeticRisk parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseEmeticRiskKey in: path description: CareCaseEmeticRisk Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseEmeticRisk' text/json: schema: $ref: '#/components/schemas/CareCaseEmeticRisk' application/*+json: schema: $ref: '#/components/schemas/CareCaseEmeticRisk' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseEmeticRiskVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseEmeticRiskVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseEmeticRiskVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Emetic Risks summary: Delete CareCaseEmeticRisk description: Deletes an CareCaseEmeticRisk operationId: DeleteCareCaseEmeticRisk parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseEmeticRiskKey in: path description: CareCaseEmeticRisk Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /emetic-risks-batch: put: tags: - Care Case Emetic Risks summary: Create or Update Batch CareCaseEmeticRisk description: 'Create or Update multiple CareCaseEmeticRisk at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseEmeticRisk parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseEmeticRisk' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseEmeticRisk' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseEmeticRisk' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/intakes': post: tags: - Care Case Intakes summary: Create CareCaseIntake description: Creates a new CareCaseIntake operationId: CreateCareCaseIntake parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseIntake' text/json: schema: $ref: '#/components/schemas/CareCaseIntake' application/*+json: schema: $ref: '#/components/schemas/CareCaseIntake' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntakeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntakeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Intakes summary: List CareCaseIntake description: Lists all CareCaseIntake for the given caseKey operationId: ListCareCaseIntake parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntakeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntakeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/intakes/{careCaseIntakeKey}': get: tags: - Care Case Intakes summary: Get CareCaseIntake description: Gets CareCaseIntake operationId: GetCareCaseIntake parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseIntakeKey in: path description: CareCaseIntake Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntakeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntakeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Intakes summary: Update CareCaseIntake description: Updates a specific CareCaseIntake. operationId: UpdateCareCaseIntake parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseIntakeKey in: path description: CareCaseIntake Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseIntake' text/json: schema: $ref: '#/components/schemas/CareCaseIntake' application/*+json: schema: $ref: '#/components/schemas/CareCaseIntake' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntakeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntakeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Intakes summary: Delete CareCaseIntake description: Deletes an CareCaseIntake operationId: DeleteCareCaseIntake parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseIntakeKey in: path description: CareCaseIntake Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/intakes-batch': put: tags: - Care Case Intakes summary: Create or Update Batch CareCaseIntake description: 'Create or Update multiple CareCaseIntake at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseIntake parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseIntake' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseIntake' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseIntake' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/intake-types/{careCaseIntakeTypeID}/secondary-types': post: tags: - Care Case Intake Secondary Types summary: Create CareCaseIntakeSecondaryType description: Creates a new CareCaseIntakeSecondaryType operationId: CreateCareCaseIntakeSecondaryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseIntakeTypeID in: path description: CareCaseIntakeType ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryType' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryType' application/*+json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Intake Secondary Types summary: List CareCaseIntakeSecondaryType description: Lists all CareCaseIntakeSecondaryType for the given careCaseIntakeTypeID operationId: ListCareCaseIntakeSecondaryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseIntakeTypeID in: path description: CareCaseIntakeType ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/intake-types/{careCaseIntakeTypeID}/secondary-types/{careCaseIntakeSecondaryTypeID}': get: tags: - Care Case Intake Secondary Types summary: Get CareCaseIntakeSecondaryType description: Gets CareCaseIntakeSecondaryType operationId: GetCareCaseIntakeSecondaryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseIntakeTypeID in: path description: CareCaseIntakeType ID required: true schema: type: string - name: careCaseIntakeSecondaryTypeID in: path description: CareCaseIntakeSecondaryType ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Intake Secondary Types summary: Update CareCaseIntakeSecondaryType description: Updates a specific CareCaseIntakeSecondaryType. operationId: UpdateCareCaseIntakeSecondaryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseIntakeTypeID in: path description: CareCaseIntakeType ID required: true schema: type: string - name: careCaseIntakeSecondaryTypeID in: path description: CareCaseIntakeSecondaryType ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryType' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryType' application/*+json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeSecondaryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Intake Secondary Types summary: Delete CareCaseIntakeSecondaryType description: Deletes an CareCaseIntakeSecondaryType operationId: DeleteCareCaseIntakeSecondaryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseIntakeTypeID in: path description: CareCaseIntakeType ID required: true schema: type: string - name: careCaseIntakeSecondaryTypeID in: path description: CareCaseIntakeSecondaryType ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/intake-types/{careCaseIntakeTypeID}/secondary-types-batch': put: tags: - Care Case Intake Secondary Types summary: Create or Update Batch CareCaseIntakeSecondaryType description: 'Create or Update multiple CareCaseIntakeSecondaryType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseIntakeSecondaryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseIntakeTypeID in: path description: CareCaseIntakeType ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseIntakeSecondaryType' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseIntakeSecondaryType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseIntakeSecondaryType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /intake-types: post: tags: - Care Case Intake Types summary: Create CareCaseIntakeType description: Creates a new CareCaseIntakeType operationId: CreateCareCaseIntakeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseIntakeType' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeType' application/*+json: schema: $ref: '#/components/schemas/CareCaseIntakeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntakeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntakeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Intake Types summary: List CareCaseIntakeType description: Lists all CareCaseIntakeType operationId: ListCareCaseIntakeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntakeTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntakeTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/intake-types/{careCaseIntakeTypeID}': get: tags: - Care Case Intake Types summary: Get CareCaseIntakeType description: Gets CareCaseIntakeType operationId: GetCareCaseIntakeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseIntakeTypeID in: path description: CareCaseIntakeType ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntakeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntakeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Intake Types summary: Update CareCaseIntakeType description: Updates a specific CareCaseIntakeType. operationId: UpdateCareCaseIntakeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseIntakeTypeID in: path description: CareCaseIntakeType ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseIntakeType' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeType' application/*+json: schema: $ref: '#/components/schemas/CareCaseIntakeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntakeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntakeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntakeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Intake Types summary: Delete CareCaseIntakeType description: Deletes an CareCaseIntakeType operationId: DeleteCareCaseIntakeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseIntakeTypeID in: path description: CareCaseIntakeType ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /intake-types-batch: put: tags: - Care Case Intake Types summary: Create or Update Batch CareCaseIntakeType description: 'Create or Update multiple CareCaseIntakeType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseIntakeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseIntakeType' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseIntakeType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseIntakeType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-intents: post: tags: - Care Case Intents summary: Create CareCaseIntent description: Creates a new CareCaseIntent operationId: CreateCareCaseIntent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseIntent' text/json: schema: $ref: '#/components/schemas/CareCaseIntent' application/*+json: schema: $ref: '#/components/schemas/CareCaseIntent' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntentVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntentVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Intents summary: List CareCaseIntent description: Lists all CareCaseIntent operationId: ListCareCaseIntent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntentListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntentListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-intents/{careCaseIntentKey}': get: tags: - Care Case Intents summary: Get CareCaseIntent description: Gets CareCaseIntent operationId: GetCareCaseIntent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseIntentKey in: path description: CareCaseIntent Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntentVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntentVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Intents summary: Update CareCaseIntent description: Updates a specific CareCaseIntent. operationId: UpdateCareCaseIntent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseIntentKey in: path description: CareCaseIntent Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseIntent' text/json: schema: $ref: '#/components/schemas/CareCaseIntent' application/*+json: schema: $ref: '#/components/schemas/CareCaseIntent' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseIntentVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseIntentVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseIntentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Intents summary: Delete CareCaseIntent description: Deletes an CareCaseIntent operationId: DeleteCareCaseIntent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseIntentKey in: path description: CareCaseIntent Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-intents-batch: put: tags: - Care Case Intents summary: Create or Update Batch CareCaseIntent description: 'Create or Update multiple CareCaseIntent at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseIntent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseIntent' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseIntent' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseIntent' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-log-entry-types: post: tags: - Care Case Log Entry Types summary: Create CareCaseLogEntryType description: Creates a new CareCaseLogEntryType operationId: CreateCareCaseLogEntryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseLogEntryType' text/json: schema: $ref: '#/components/schemas/CareCaseLogEntryType' application/*+json: schema: $ref: '#/components/schemas/CareCaseLogEntryType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseLogEntryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseLogEntryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseLogEntryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Log Entry Types summary: List CareCaseLogEntryType description: Lists all CareCaseLogEntryType operationId: ListCareCaseLogEntryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseLogEntryTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseLogEntryTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseLogEntryTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-log-entry-types/{careCaseLogEntryTypeKey}': get: tags: - Care Case Log Entry Types summary: Get CareCaseLogEntryType description: Gets CareCaseLogEntryType operationId: GetCareCaseLogEntryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseLogEntryTypeKey in: path description: CareCaseLogEntryType Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseLogEntryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseLogEntryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseLogEntryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Log Entry Types summary: Update CareCaseLogEntryType description: Updates a specific CareCaseLogEntryType. operationId: UpdateCareCaseLogEntryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseLogEntryTypeKey in: path description: CareCaseLogEntryType Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseLogEntryType' text/json: schema: $ref: '#/components/schemas/CareCaseLogEntryType' application/*+json: schema: $ref: '#/components/schemas/CareCaseLogEntryType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseLogEntryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseLogEntryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseLogEntryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Log Entry Types summary: Delete CareCaseLogEntryType description: Deletes an CareCaseLogEntryType operationId: DeleteCareCaseLogEntryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseLogEntryTypeKey in: path description: CareCaseLogEntryType Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-log-entry-types-batch: put: tags: - Care Case Log Entry Types summary: Create or Update Batch CareCaseLogEntryType description: 'Create or Update multiple CareCaseLogEntryType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseLogEntryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseLogEntryType' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseLogEntryType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseLogEntryType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-lots: post: tags: - Care Case Lots summary: Create CareCaseLot description: Creates a new CareCaseLot operationId: CreateCareCaseLot parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseLot' text/json: schema: $ref: '#/components/schemas/CareCaseLot' application/*+json: schema: $ref: '#/components/schemas/CareCaseLot' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseLotVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseLotVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseLotVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Lots summary: List CareCaseLot description: Lists all CareCaseLot operationId: ListCareCaseLot parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseLotListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseLotListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseLotListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-lots/{careCaseLotKey}': get: tags: - Care Case Lots summary: Get CareCaseLot description: Gets CareCaseLot operationId: GetCareCaseLot parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseLotKey in: path description: CareCaseLot Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseLotVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseLotVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseLotVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Lots summary: Update CareCaseLot description: Updates a specific CareCaseLot. operationId: UpdateCareCaseLot parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseLotKey in: path description: CareCaseLot Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseLot' text/json: schema: $ref: '#/components/schemas/CareCaseLot' application/*+json: schema: $ref: '#/components/schemas/CareCaseLot' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseLotVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseLotVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseLotVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Lots summary: Delete CareCaseLot description: Deletes an CareCaseLot operationId: DeleteCareCaseLot parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseLotKey in: path description: CareCaseLot Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-lots-batch: put: tags: - Care Case Lots summary: Create or Update Batch CareCaseLot description: 'Create or Update multiple CareCaseLot at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseLot parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseLot' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseLot' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseLot' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/medications': post: tags: - Care Case Medications summary: Create CareCaseMedication description: Creates a new CareCaseMedication operationId: CreateCareCaseMedication parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseMedication' text/json: schema: $ref: '#/components/schemas/CareCaseMedication' application/*+json: schema: $ref: '#/components/schemas/CareCaseMedication' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseMedicationVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseMedicationVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseMedicationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Medications summary: List CareCaseMedication description: Lists all CareCaseMedication for the given caseKey operationId: ListCareCaseMedication parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseMedicationListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseMedicationListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseMedicationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/medications/{careCaseMedicationKey}': get: tags: - Care Case Medications summary: Get CareCaseMedication description: Gets CareCaseMedication operationId: GetCareCaseMedication parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseMedicationKey in: path description: CareCaseMedication Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseMedicationVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseMedicationVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseMedicationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Medications summary: Update CareCaseMedication description: Updates a specific CareCaseMedication. operationId: UpdateCareCaseMedication parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseMedicationKey in: path description: CareCaseMedication Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseMedication' text/json: schema: $ref: '#/components/schemas/CareCaseMedication' application/*+json: schema: $ref: '#/components/schemas/CareCaseMedication' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseMedicationVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseMedicationVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseMedicationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Medications summary: Delete CareCaseMedication description: Deletes an CareCaseMedication operationId: DeleteCareCaseMedication parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseMedicationKey in: path description: CareCaseMedication Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/medications-batch': put: tags: - Care Case Medications summary: Create or Update Batch CareCaseMedication description: 'Create or Update multiple CareCaseMedication at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseMedication parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseMedication' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseMedication' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseMedication' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/members': post: tags: - Care Case Members summary: Create CareCaseMember description: Creates a new CareCaseMember operationId: CreateCareCaseMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseMember' text/json: schema: $ref: '#/components/schemas/CareCaseMember' application/*+json: schema: $ref: '#/components/schemas/CareCaseMember' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseMemberVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseMemberVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseMemberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Members summary: List CareCaseMember description: Lists all CareCaseMember for the given caseKey operationId: ListCareCaseMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseMemberListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseMemberListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseMemberListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/members/{subscriberID}/{memberSeq}': get: tags: - Care Case Members summary: Get CareCaseMember description: Gets CareCaseMember operationId: GetCareCaseMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseMemberVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseMemberVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseMemberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Members summary: Update CareCaseMember description: Updates a specific CareCaseMember. operationId: UpdateCareCaseMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseMember' text/json: schema: $ref: '#/components/schemas/CareCaseMember' application/*+json: schema: $ref: '#/components/schemas/CareCaseMember' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseMemberVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseMemberVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseMemberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Members summary: Delete CareCaseMember description: Deletes an CareCaseMember operationId: DeleteCareCaseMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/members-batch': put: tags: - Care Case Members summary: Create or Update Batch CareCaseMember description: 'Create or Update multiple CareCaseMember at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseMember' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseMember' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseMember' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-neutropenic-risks: post: tags: - Care Case Neutropenic Risks summary: Create CareCaseNeutropenicRisk description: Creates a new CareCaseNeutropenicRisk operationId: CreateCareCaseNeutropenicRisk parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRisk' text/json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRisk' application/*+json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRisk' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseNeutropenicRiskVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRiskVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRiskVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Neutropenic Risks summary: List CareCaseNeutropenicRisk description: Lists all CareCaseNeutropenicRisk operationId: ListCareCaseNeutropenicRisk parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseNeutropenicRiskListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRiskListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRiskListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-neutropenic-risks/{careCaseNeutropenicRiskKey}': get: tags: - Care Case Neutropenic Risks summary: Get CareCaseNeutropenicRisk description: Gets CareCaseNeutropenicRisk operationId: GetCareCaseNeutropenicRisk parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseNeutropenicRiskKey in: path description: CareCaseNeutropenicRisk Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseNeutropenicRiskVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRiskVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRiskVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Neutropenic Risks summary: Update CareCaseNeutropenicRisk description: Updates a specific CareCaseNeutropenicRisk. operationId: UpdateCareCaseNeutropenicRisk parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseNeutropenicRiskKey in: path description: CareCaseNeutropenicRisk Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRisk' text/json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRisk' application/*+json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRisk' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseNeutropenicRiskVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRiskVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseNeutropenicRiskVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Neutropenic Risks summary: Delete CareCaseNeutropenicRisk description: Deletes an CareCaseNeutropenicRisk operationId: DeleteCareCaseNeutropenicRisk parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseNeutropenicRiskKey in: path description: CareCaseNeutropenicRisk Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-neutropenic-risks-batch: put: tags: - Care Case Neutropenic Risks summary: Create or Update Batch CareCaseNeutropenicRisk description: 'Create or Update multiple CareCaseNeutropenicRisk at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseNeutropenicRisk parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseNeutropenicRisk' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseNeutropenicRisk' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseNeutropenicRisk' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/providers': post: tags: - Care Case Providers summary: Create CareCaseProvider description: Creates a new CareCaseProvider operationId: CreateCareCaseProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseProvider' text/json: schema: $ref: '#/components/schemas/CareCaseProvider' application/*+json: schema: $ref: '#/components/schemas/CareCaseProvider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseProviderVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseProviderVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseProviderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Providers summary: List CareCaseProvider description: Lists all CareCaseProvider for the given caseKey operationId: ListCareCaseProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseProviderListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseProviderListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseProviderListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/providers/{careCaseProviderKey}': get: tags: - Care Case Providers summary: Get CareCaseProvider description: Gets CareCaseProvider operationId: GetCareCaseProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseProviderKey in: path description: CareCaseProvider Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseProviderVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseProviderVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseProviderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Providers summary: Update CareCaseProvider description: Updates a specific CareCaseProvider. operationId: UpdateCareCaseProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseProviderKey in: path description: CareCaseProvider Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseProvider' text/json: schema: $ref: '#/components/schemas/CareCaseProvider' application/*+json: schema: $ref: '#/components/schemas/CareCaseProvider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseProviderVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseProviderVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseProviderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Providers summary: Delete CareCaseProvider description: Deletes an CareCaseProvider operationId: DeleteCareCaseProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseProviderKey in: path description: CareCaseProvider Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/providers-batch': put: tags: - Care Case Providers summary: Create or Update Batch CareCaseProvider description: 'Create or Update multiple CareCaseProvider at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseProvider' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseProvider' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseProvider' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/savings': post: tags: - Care Case Savings summary: Create CareCaseSavings description: Creates a new CareCaseSavings operationId: CreateCareCaseSavings parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseSavings' text/json: schema: $ref: '#/components/schemas/CareCaseSavings' application/*+json: schema: $ref: '#/components/schemas/CareCaseSavings' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseSavingsVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseSavingsVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Savings summary: List CareCaseSavings description: Lists all CareCaseSavings for the given caseKey operationId: ListCareCaseSavings parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseSavingsListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseSavingsListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/savings/{careCaseSavingsKey}': get: tags: - Care Case Savings summary: Get CareCaseSavings description: Gets CareCaseSavings operationId: GetCareCaseSavings parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseSavingsKey in: path description: CareCaseSavings Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseSavingsVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseSavingsVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Savings summary: Update CareCaseSavings description: Updates a specific CareCaseSavings. operationId: UpdateCareCaseSavings parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseSavingsKey in: path description: CareCaseSavings Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseSavings' text/json: schema: $ref: '#/components/schemas/CareCaseSavings' application/*+json: schema: $ref: '#/components/schemas/CareCaseSavings' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseSavingsVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseSavingsVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Savings summary: Delete CareCaseSavings description: Deletes an CareCaseSavings operationId: DeleteCareCaseSavings parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseSavingsKey in: path description: CareCaseSavings Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/savings-batch': put: tags: - Care Case Savings summary: Create or Update Batch CareCaseSavings description: 'Create or Update multiple CareCaseSavings at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseSavings parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseSavings' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseSavings' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseSavings' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-savings-types/{savingsType}/secondary-types': post: tags: - Care Case Savings Secondary Types summary: Create CareCaseSavingsSecondaryType description: Creates a new CareCaseSavingsSecondaryType operationId: CreateCareCaseSavingsSecondaryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: savingsType in: path description: Savings Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryType' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryType' application/*+json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Savings Secondary Types summary: List CareCaseSavingsSecondaryType description: Lists all CareCaseSavingsSecondaryType for the given savingsType operationId: ListCareCaseSavingsSecondaryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: savingsType in: path description: Savings Type required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-savings-types/{savingsType}/secondary-types/{careCaseSavingsSecondaryType}': get: tags: - Care Case Savings Secondary Types summary: Get CareCaseSavingsSecondaryType description: Gets CareCaseSavingsSecondaryType operationId: GetCareCaseSavingsSecondaryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: savingsType in: path description: Savings Type required: true schema: type: string - name: careCaseSavingsSecondaryType in: path description: CareCaseSavingsSecondary Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Savings Secondary Types summary: Update CareCaseSavingsSecondaryType description: Updates a specific CareCaseSavingsSecondaryType. operationId: UpdateCareCaseSavingsSecondaryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: savingsType in: path description: Savings Type required: true schema: type: string - name: careCaseSavingsSecondaryType in: path description: CareCaseSavingsSecondary Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryType' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryType' application/*+json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsSecondaryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Savings Secondary Types summary: Delete CareCaseSavingsSecondaryType description: Deletes an CareCaseSavingsSecondaryType operationId: DeleteCareCaseSavingsSecondaryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: savingsType in: path description: Savings Type required: true schema: type: string - name: careCaseSavingsSecondaryType in: path description: CareCaseSavingsSecondary Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-savings-types/{savingsType}/secondary-types-batch': put: tags: - Care Case Savings Secondary Types summary: Create or Update Batch CareCaseSavingsSecondaryType description: 'Create or Update multiple CareCaseSavingsSecondaryType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseSavingsSecondaryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: savingsType in: path description: Savings Type required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseSavingsSecondaryType' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseSavingsSecondaryType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseSavingsSecondaryType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-savings-types: post: tags: - Care Case Savings Types summary: Create CareCaseSavingsType description: Creates a new CareCaseSavingsType operationId: CreateCareCaseSavingsType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseSavingsType' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsType' application/*+json: schema: $ref: '#/components/schemas/CareCaseSavingsType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseSavingsTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseSavingsTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Savings Types summary: List CareCaseSavingsType description: Lists all CareCaseSavingsType operationId: ListCareCaseSavingsType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseSavingsTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseSavingsTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-savings-types/{savingsType}': get: tags: - Care Case Savings Types summary: Get CareCaseSavingsType description: Gets CareCaseSavingsType operationId: GetCareCaseSavingsType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: savingsType in: path description: Savings Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseSavingsTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseSavingsTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Savings Types summary: Update CareCaseSavingsType description: Updates a specific CareCaseSavingsType. operationId: UpdateCareCaseSavingsType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: savingsType in: path description: Savings Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseSavingsType' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsType' application/*+json: schema: $ref: '#/components/schemas/CareCaseSavingsType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseSavingsTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseSavingsTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseSavingsTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Savings Types summary: Delete CareCaseSavingsType description: Deletes an CareCaseSavingsType operationId: DeleteCareCaseSavingsType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: savingsType in: path description: Savings Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-savings-types-batch: put: tags: - Care Case Savings Types summary: Create or Update Batch CareCaseSavingsType description: 'Create or Update multiple CareCaseSavingsType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseSavingsType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseSavingsType' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseSavingsType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseSavingsType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-stages: post: tags: - Care Case Stages summary: Create CareCaseStage description: Creates a new CareCaseStage operationId: CreateCareCaseStage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseStage' text/json: schema: $ref: '#/components/schemas/CareCaseStage' application/*+json: schema: $ref: '#/components/schemas/CareCaseStage' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseStageVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseStageVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseStageVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Stages summary: List CareCaseStage description: Lists all CareCaseStage operationId: ListCareCaseStage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseStageListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseStageListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseStageListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-stages/{careCaseStageKey}': get: tags: - Care Case Stages summary: Get CareCaseStage description: Gets CareCaseStage operationId: GetCareCaseStage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseStageKey in: path description: CareCaseStage Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseStageVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseStageVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseStageVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Stages summary: Update CareCaseStage description: Updates a specific CareCaseStage. operationId: UpdateCareCaseStage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseStageKey in: path description: CareCaseStage Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseStage' text/json: schema: $ref: '#/components/schemas/CareCaseStage' application/*+json: schema: $ref: '#/components/schemas/CareCaseStage' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseStageVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseStageVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseStageVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Stages summary: Delete CareCaseStage description: Deletes an CareCaseStage operationId: DeleteCareCaseStage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careCaseStageKey in: path description: CareCaseStage Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-stages-batch: put: tags: - Care Case Stages summary: Create or Update Batch CareCaseStage description: 'Create or Update multiple CareCaseStage at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseStage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseStage' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseStage' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseStage' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/treatments': post: tags: - Care Case Treatments summary: Create CareCaseTreatment description: Creates a new CareCaseTreatment operationId: CreateCareCaseTreatment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseTreatment' text/json: schema: $ref: '#/components/schemas/CareCaseTreatment' application/*+json: schema: $ref: '#/components/schemas/CareCaseTreatment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseTreatmentVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseTreatmentVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseTreatmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Treatments summary: List CareCaseTreatment description: Lists all CareCaseTreatment for the given caseKey operationId: ListCareCaseTreatment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseTreatmentListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseTreatmentListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseTreatmentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/treatments/{careCaseTreatmentKey}': get: tags: - Care Case Treatments summary: Get CareCaseTreatment description: Gets CareCaseTreatment operationId: GetCareCaseTreatment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseTreatmentKey in: path description: CareCaseTreatment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseTreatmentVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseTreatmentVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseTreatmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Treatments summary: Update CareCaseTreatment description: Updates a specific CareCaseTreatment. operationId: UpdateCareCaseTreatment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseTreatmentKey in: path description: CareCaseTreatment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseTreatment' text/json: schema: $ref: '#/components/schemas/CareCaseTreatment' application/*+json: schema: $ref: '#/components/schemas/CareCaseTreatment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseTreatmentVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseTreatmentVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseTreatmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Treatments summary: Delete CareCaseTreatment description: Deletes an CareCaseTreatment operationId: DeleteCareCaseTreatment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseTreatmentKey in: path description: CareCaseTreatment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/treatments-batch': put: tags: - Care Case Treatments summary: Create or Update Batch CareCaseTreatment description: 'Create or Update multiple CareCaseTreatment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseTreatment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseTreatment' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseTreatment' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseTreatment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-treatment-types: post: tags: - Care Case Treatment Types summary: Create CareCaseTreatmentType description: Creates a new CareCaseTreatmentType operationId: CreateCareCaseTreatmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseTreatmentType' text/json: schema: $ref: '#/components/schemas/CareCaseTreatmentType' application/*+json: schema: $ref: '#/components/schemas/CareCaseTreatmentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseTreatmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseTreatmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseTreatmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Treatment Types summary: List CareCaseTreatmentType description: Lists all CareCaseTreatmentType operationId: ListCareCaseTreatmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseTreatmentTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseTreatmentTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseTreatmentTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-treatment-types/{treatmentType}': get: tags: - Care Case Treatment Types summary: Get CareCaseTreatmentType description: Gets CareCaseTreatmentType operationId: GetCareCaseTreatmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: treatmentType in: path description: Treatment Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseTreatmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseTreatmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseTreatmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Treatment Types summary: Update CareCaseTreatmentType description: Updates a specific CareCaseTreatmentType. operationId: UpdateCareCaseTreatmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: treatmentType in: path description: Treatment Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseTreatmentType' text/json: schema: $ref: '#/components/schemas/CareCaseTreatmentType' application/*+json: schema: $ref: '#/components/schemas/CareCaseTreatmentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseTreatmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseTreatmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseTreatmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Treatment Types summary: Delete CareCaseTreatmentType description: Deletes an CareCaseTreatmentType operationId: DeleteCareCaseTreatmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: treatmentType in: path description: Treatment Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-treatment-types-batch: put: tags: - Care Case Treatment Types summary: Create or Update Batch CareCaseTreatmentType description: 'Create or Update multiple CareCaseTreatmentType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseTreatmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseTreatmentType' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseTreatmentType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseTreatmentType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/work-logs': post: tags: - Care Case Work Logs summary: Create CareCaseWorkLog description: Creates a new CareCaseWorkLog operationId: CreateCareCaseWorkLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseWorkLog' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLog' application/*+json: schema: $ref: '#/components/schemas/CareCaseWorkLog' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkLogVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Work Logs summary: List CareCaseWorkLog description: Lists all CareCaseWorkLog for the given caseKey operationId: ListCareCaseWorkLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkLogListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/work-logs/{careCaseWorkLogKey}': get: tags: - Care Case Work Logs summary: Get CareCaseWorkLog description: Gets CareCaseWorkLog operationId: GetCareCaseWorkLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseWorkLogKey in: path description: CareCaseWorkLog Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkLogVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Work Logs summary: Update CareCaseWorkLog description: Updates a specific CareCaseWorkLog. operationId: UpdateCareCaseWorkLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseWorkLogKey in: path description: CareCaseWorkLog Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseWorkLog' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLog' application/*+json: schema: $ref: '#/components/schemas/CareCaseWorkLog' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkLogVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Work Logs summary: Delete CareCaseWorkLog description: Deletes an CareCaseWorkLog operationId: DeleteCareCaseWorkLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 - name: careCaseWorkLogKey in: path description: CareCaseWorkLog Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cases/{caseKey}/work-logs-batch': put: tags: - Care Case Work Logs summary: Create or Update Batch CareCaseWorkLog description: 'Create or Update multiple CareCaseWorkLog at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseWorkLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseKey in: path description: Case Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseWorkLog' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseWorkLog' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseWorkLog' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-work-log-types/{workLogType}/savings-types': post: tags: - Care Case Work Log Savings Types summary: Create CareCaseWorkLogSavingsType description: Creates a new CareCaseWorkLogSavingsType operationId: CreateCareCaseWorkLogSavingsType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsType' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsType' application/*+json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Work Log Savings Types summary: List CareCaseWorkLogSavingsType description: Lists all CareCaseWorkLogSavingsType for the given workLogType operationId: ListCareCaseWorkLogSavingsType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-work-log-types/{workLogType}/savings-types/{savingsType}': get: tags: - Care Case Work Log Savings Types summary: Get CareCaseWorkLogSavingsType description: Gets CareCaseWorkLogSavingsType operationId: GetCareCaseWorkLogSavingsType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string - name: savingsType in: path description: Savings Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Work Log Savings Types summary: Update CareCaseWorkLogSavingsType description: Updates a specific CareCaseWorkLogSavingsType. operationId: UpdateCareCaseWorkLogSavingsType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string - name: savingsType in: path description: Savings Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsType' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsType' application/*+json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogSavingsTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Work Log Savings Types summary: Delete CareCaseWorkLogSavingsType description: Deletes an CareCaseWorkLogSavingsType operationId: DeleteCareCaseWorkLogSavingsType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string - name: savingsType in: path description: Savings Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-work-log-types/{workLogType}/savings-types-batch': put: tags: - Care Case Work Log Savings Types summary: Create or Update Batch CareCaseWorkLogSavingsType description: 'Create or Update multiple CareCaseWorkLogSavingsType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseWorkLogSavingsType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseWorkLogSavingsType' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseWorkLogSavingsType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseWorkLogSavingsType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-work-log-types: post: tags: - Care Case Work Log Types summary: Create CareCaseWorkLogType description: Creates a new CareCaseWorkLogType operationId: CreateCareCaseWorkLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogType' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogType' application/*+json: schema: $ref: '#/components/schemas/CareCaseWorkLogType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkLogTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Work Log Types summary: List CareCaseWorkLogType description: Lists all CareCaseWorkLogType operationId: ListCareCaseWorkLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkLogTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-work-log-types/{workLogType}': get: tags: - Care Case Work Log Types summary: Get CareCaseWorkLogType description: Gets CareCaseWorkLogType operationId: GetCareCaseWorkLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkLogTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Work Log Types summary: Update CareCaseWorkLogType description: Updates a specific CareCaseWorkLogType. operationId: UpdateCareCaseWorkLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogType' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogType' application/*+json: schema: $ref: '#/components/schemas/CareCaseWorkLogType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkLogTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkLogTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkLogTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Work Log Types summary: Delete CareCaseWorkLogType description: Deletes an CareCaseWorkLogType operationId: DeleteCareCaseWorkLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-case-work-log-types-batch: put: tags: - Care Case Work Log Types summary: Create or Update Batch CareCaseWorkLogType description: 'Create or Update multiple CareCaseWorkLogType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseWorkLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseWorkLogType' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseWorkLogType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseWorkLogType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-work-log-types/{workLogType}/secondary-log-types': post: tags: - Care Case Work Log Secondary Log Types summary: Create CareCaseWorkSecondaryLogType description: Creates a new CareCaseWorkSecondaryLogType operationId: CreateCareCaseWorkSecondaryLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogType' text/json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogType' application/*+json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Case Work Log Secondary Log Types summary: List CareCaseWorkSecondaryLogType description: Lists all CareCaseWorkSecondaryLogType for the given workLogType operationId: ListCareCaseWorkSecondaryLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-work-log-types/{workLogType}/secondary-log-types/{workLogSecondaryType}': get: tags: - Care Case Work Log Secondary Log Types summary: Get CareCaseWorkSecondaryLogType description: Gets CareCaseWorkSecondaryLogType operationId: GetCareCaseWorkSecondaryLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string - name: workLogSecondaryType in: path description: WorkLog SecondaryType required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Case Work Log Secondary Log Types summary: Update CareCaseWorkSecondaryLogType description: Updates a specific CareCaseWorkSecondaryLogType. operationId: UpdateCareCaseWorkSecondaryLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string - name: workLogSecondaryType in: path description: WorkLog SecondaryType required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogType' text/json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogType' application/*+json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareCaseWorkSecondaryLogTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Case Work Log Secondary Log Types summary: Delete CareCaseWorkSecondaryLogType description: Deletes an CareCaseWorkSecondaryLogType operationId: DeleteCareCaseWorkSecondaryLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string - name: workLogSecondaryType in: path description: WorkLog SecondaryType required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-case-work-log-types/{workLogType}/secondary-log-types-batch': put: tags: - Care Case Work Log Secondary Log Types summary: Create or Update Batch CareCaseWorkSecondaryLogType description: 'Create or Update multiple CareCaseWorkSecondaryLogType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareCaseWorkSecondaryLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workLogType in: path description: WorkLog Type required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareCaseWorkSecondaryLogType' text/json: schema: type: array items: $ref: '#/components/schemas/CareCaseWorkSecondaryLogType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareCaseWorkSecondaryLogType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-managers: post: tags: - Care Managers summary: Create CareManager description: Creates a new CareManager operationId: CreateCareManager parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareManager' text/json: schema: $ref: '#/components/schemas/CareManager' application/*+json: schema: $ref: '#/components/schemas/CareManager' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Managers summary: List CareManager description: Lists all CareManager operationId: ListCareManager parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-managers/{careManagerKey}': get: tags: - Care Managers summary: Get CareManager description: Gets CareManager operationId: GetCareManager parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Managers summary: Update CareManager description: Updates a specific CareManager. operationId: UpdateCareManager parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareManager' text/json: schema: $ref: '#/components/schemas/CareManager' application/*+json: schema: $ref: '#/components/schemas/CareManager' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Managers summary: Delete CareManager description: Deletes an CareManager operationId: DeleteCareManager parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-managers-batch: put: tags: - Care Managers summary: Create or Update Batch CareManager description: 'Create or Update multiple CareManager at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareManager parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareManager' text/json: schema: type: array items: $ref: '#/components/schemas/CareManager' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareManager' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-managers/{careManagerKey}/care-plans': post: tags: - Care Manager Care Plans summary: Create CareManagerCarePlan description: Creates a new CareManagerCarePlan operationId: CreateCareManagerCarePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareManagerCarePlan' text/json: schema: $ref: '#/components/schemas/CareManagerCarePlan' application/*+json: schema: $ref: '#/components/schemas/CareManagerCarePlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerCarePlanVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerCarePlanVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerCarePlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Manager Care Plans summary: List CareManagerCarePlan description: Lists all CareManagerCarePlan for the given careManagerKey operationId: ListCareManagerCarePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerCarePlanListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerCarePlanListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerCarePlanListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-managers/{careManagerKey}/care-plans/{carePlanKey}': get: tags: - Care Manager Care Plans summary: Get CareManagerCarePlan description: Gets CareManagerCarePlan operationId: GetCareManagerCarePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerCarePlanVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerCarePlanVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerCarePlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Manager Care Plans summary: Delete CareManagerCarePlan description: Deletes an CareManagerCarePlan operationId: DeleteCareManagerCarePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-managers/{careManagerKey}/care-plans-batch': put: tags: - Care Manager Care Plans summary: Create or Update Batch CareManagerCarePlan description: 'Create or Update multiple CareManagerCarePlan at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareManagerCarePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareManagerCarePlan' text/json: schema: type: array items: $ref: '#/components/schemas/CareManagerCarePlan' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareManagerCarePlan' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-managers/{careManagerKey}/care-types': post: tags: - Care Manager Care Types summary: Create CareManagerCareType description: Creates a new CareManagerCareType operationId: CreateCareManagerCareType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareManagerCareType' text/json: schema: $ref: '#/components/schemas/CareManagerCareType' application/*+json: schema: $ref: '#/components/schemas/CareManagerCareType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerCareTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerCareTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerCareTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Manager Care Types summary: List CareManagerCareType description: Lists all CareManagerCareType for the given careManagerKey operationId: ListCareManagerCareType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerCareTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerCareTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerCareTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-managers/{careManagerKey}/care-types/{careType}': get: tags: - Care Manager Care Types summary: Get CareManagerCareType description: Gets CareManagerCareType operationId: GetCareManagerCareType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 - name: careType in: path description: Care Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerCareTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerCareTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerCareTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Manager Care Types summary: Delete CareManagerCareType description: Deletes an CareManagerCareType operationId: DeleteCareManagerCareType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 - name: careType in: path description: Care Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-managers/{careManagerKey}/care-types-batch': put: tags: - Care Manager Care Types summary: Create or Update Batch CareManagerCareType description: 'Create or Update multiple CareManagerCareType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareManagerCareType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareManagerCareType' text/json: schema: type: array items: $ref: '#/components/schemas/CareManagerCareType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareManagerCareType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-managers/{careManagerKey}/cases': post: tags: - Care Manager Cases summary: Create CareManagerCase description: Creates a new CareManagerCase operationId: CreateCareManagerCase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareManagerCase' text/json: schema: $ref: '#/components/schemas/CareManagerCase' application/*+json: schema: $ref: '#/components/schemas/CareManagerCase' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerCaseVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerCaseVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerCaseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Manager Cases summary: List CareManagerCase description: Lists all CareManagerCase for the given careManagerKey operationId: ListCareManagerCase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerCaseListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerCaseListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerCaseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-managers/{careManagerKey}/cases/{careManagerCaseKey}': get: tags: - Care Manager Cases summary: Get CareManagerCase description: Gets CareManagerCase operationId: GetCareManagerCase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 - name: careManagerCaseKey in: path description: CareManagerCase Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerCaseVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerCaseVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerCaseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Manager Cases summary: Update CareManagerCase description: Updates a specific CareManagerCase. operationId: UpdateCareManagerCase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 - name: careManagerCaseKey in: path description: CareManagerCase Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareManagerCase' text/json: schema: $ref: '#/components/schemas/CareManagerCase' application/*+json: schema: $ref: '#/components/schemas/CareManagerCase' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerCaseVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerCaseVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerCaseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Manager Cases summary: Delete CareManagerCase description: Deletes an CareManagerCase operationId: DeleteCareManagerCase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 - name: careManagerCaseKey in: path description: CareManagerCase Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-managers/{careManagerKey}/cases-batch': put: tags: - Care Manager Cases summary: Create or Update Batch CareManagerCase description: 'Create or Update multiple CareManagerCase at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareManagerCase parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareManagerCase' text/json: schema: type: array items: $ref: '#/components/schemas/CareManagerCase' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareManagerCase' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-manager-mappings: post: tags: - Care Manager Mappings summary: Create CareManagerMapping description: Creates a new CareManagerMapping operationId: CreateCareManagerMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareManagerMapping' text/json: schema: $ref: '#/components/schemas/CareManagerMapping' application/*+json: schema: $ref: '#/components/schemas/CareManagerMapping' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerMappingVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerMappingVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerMappingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Manager Mappings summary: List CareManagerMapping description: Lists all CareManagerMapping operationId: ListCareManagerMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerMappingListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerMappingListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerMappingListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-manager-mappings/{parentCareManagerKey}/{childCareManagerKey}': get: tags: - Care Manager Mappings summary: Get CareManagerMapping description: Gets CareManagerMapping operationId: GetCareManagerMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: parentCareManagerKey in: path description: Parent CareManager Key required: true schema: type: integer format: int32 - name: childCareManagerKey in: path description: Child CareManager Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerMappingVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerMappingVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerMappingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Manager Mappings summary: Delete CareManagerMapping description: Deletes an CareManagerMapping operationId: DeleteCareManagerMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: parentCareManagerKey in: path description: Parent CareManager Key required: true schema: type: integer format: int32 - name: childCareManagerKey in: path description: Child CareManager Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-manager-mappings-batch: put: tags: - Care Manager Mappings summary: Create or Update Batch CareManagerMapping description: 'Create multiple CareManagerMapping at once. If the entity exists, an error message will be returned for this record. If the entity does not exist, it will be created.' operationId: CreateBatchCareManagerMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareManagerMapping' text/json: schema: type: array items: $ref: '#/components/schemas/CareManagerMapping' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareManagerMapping' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-manager-types: post: tags: - Care Manager Types summary: Create CareManagerType description: Creates a new CareManagerType operationId: CreateCareManagerType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareManagerType' text/json: schema: $ref: '#/components/schemas/CareManagerType' application/*+json: schema: $ref: '#/components/schemas/CareManagerType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Manager Types summary: List CareManagerType description: Lists all CareManagerType operationId: ListCareManagerType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-manager-types/{careManagerType}': get: tags: - Care Manager Types summary: Get CareManagerType description: Gets CareManagerType operationId: GetCareManagerType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerType in: path description: CareManager Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Manager Types summary: Update CareManagerType description: Updates a specific CareManagerType. operationId: UpdateCareManagerType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerType in: path description: CareManager Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareManagerType' text/json: schema: $ref: '#/components/schemas/CareManagerType' application/*+json: schema: $ref: '#/components/schemas/CareManagerType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareManagerTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareManagerTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareManagerTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Manager Types summary: Delete CareManagerType description: Deletes an CareManagerType operationId: DeleteCareManagerType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careManagerType in: path description: CareManager Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-manager-types-batch: put: tags: - Care Manager Types summary: Create or Update Batch CareManagerType description: 'Create or Update multiple CareManagerType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareManagerType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareManagerType' text/json: schema: type: array items: $ref: '#/components/schemas/CareManagerType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareManagerType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-plans: post: tags: - Care Plans summary: Create CarePlan description: Creates a new CarePlan operationId: CreateCarePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlan' text/json: schema: $ref: '#/components/schemas/CarePlan' application/*+json: schema: $ref: '#/components/schemas/CarePlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Plans summary: List CarePlan description: Lists all CarePlan operationId: ListCarePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanListVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanListVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}': get: tags: - Care Plans summary: Get CarePlan description: Gets CarePlan operationId: GetCarePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Plans summary: Update CarePlan description: Updates a specific CarePlan. operationId: UpdateCarePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlan' text/json: schema: $ref: '#/components/schemas/CarePlan' application/*+json: schema: $ref: '#/components/schemas/CarePlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Plans summary: Delete CarePlan description: Deletes an CarePlan operationId: DeleteCarePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-plans-batch: put: tags: - Care Plans summary: Create or Update Batch CarePlan description: 'Create or Update multiple CarePlan at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCarePlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CarePlan' text/json: schema: type: array items: $ref: '#/components/schemas/CarePlan' application/*+json: schema: type: array items: $ref: '#/components/schemas/CarePlan' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-plan-categories: post: tags: - Care Plan Categories summary: Create CarePlanCategory description: Creates a new CarePlanCategory operationId: CreateCarePlanCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanCategory' text/json: schema: $ref: '#/components/schemas/CarePlanCategory' application/*+json: schema: $ref: '#/components/schemas/CarePlanCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Plan Categories summary: List CarePlanCategory description: Lists all CarePlanCategory operationId: ListCarePlanCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plan-categories/{carePlanCategory}': get: tags: - Care Plan Categories summary: Get CarePlanCategory description: Gets CarePlanCategory operationId: GetCarePlanCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanCategory in: path description: CarePlan Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Plan Categories summary: Update CarePlanCategory description: Updates a specific CarePlanCategory. operationId: UpdateCarePlanCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanCategory in: path description: CarePlan Category required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanCategory' text/json: schema: $ref: '#/components/schemas/CarePlanCategory' application/*+json: schema: $ref: '#/components/schemas/CarePlanCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Plan Categories summary: Delete CarePlanCategory description: Deletes an CarePlanCategory operationId: DeleteCarePlanCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanCategory in: path description: CarePlan Category required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-plan-categories-batch: put: tags: - Care Plan Categories summary: Create or Update Batch CarePlanCategory description: 'Create or Update multiple CarePlanCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCarePlanCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CarePlanCategory' text/json: schema: type: array items: $ref: '#/components/schemas/CarePlanCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/CarePlanCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/custom-values': post: tags: - Care Plan Custom Values summary: Create CarePlanCustomValue description: Creates a new CarePlanCustomValue operationId: CreateCarePlanCustomValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanCustomValue' text/json: schema: $ref: '#/components/schemas/CarePlanCustomValue' application/*+json: schema: $ref: '#/components/schemas/CarePlanCustomValue' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanCustomValueVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanCustomValueVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanCustomValueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Plan Custom Values summary: List CarePlanCustomValue description: Lists all CarePlanCustomValue for the given carePlanKey operationId: ListCarePlanCustomValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanCustomValueListVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanCustomValueListVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanCustomValueListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/custom-values/{carePlanCustomValueKey}': get: tags: - Care Plan Custom Values summary: Get CarePlanCustomValue description: Gets CarePlanCustomValue operationId: GetCarePlanCustomValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanCustomValueKey in: path description: CarePlanCustomValue Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanCustomValueVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanCustomValueVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanCustomValueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Plan Custom Values summary: Update CarePlanCustomValue description: Updates a specific CarePlanCustomValue. operationId: UpdateCarePlanCustomValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanCustomValueKey in: path description: CarePlanCustomValue Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanCustomValue' text/json: schema: $ref: '#/components/schemas/CarePlanCustomValue' application/*+json: schema: $ref: '#/components/schemas/CarePlanCustomValue' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanCustomValueVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanCustomValueVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanCustomValueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Plan Custom Values summary: Delete CarePlanCustomValue description: Deletes an CarePlanCustomValue operationId: DeleteCarePlanCustomValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanCustomValueKey in: path description: CarePlanCustomValue Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/custom-values-batch': put: tags: - Care Plan Custom Values summary: Create or Update Batch CarePlanCustomValue description: 'Create or Update multiple CarePlanCustomValue at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCarePlanCustomValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CarePlanCustomValue' text/json: schema: type: array items: $ref: '#/components/schemas/CarePlanCustomValue' application/*+json: schema: type: array items: $ref: '#/components/schemas/CarePlanCustomValue' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/details': post: tags: - Care Plan Details summary: Create CarePlanDetail description: Creates a new CarePlanDetail operationId: CreateCarePlanDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanDetail' text/json: schema: $ref: '#/components/schemas/CarePlanDetail' application/*+json: schema: $ref: '#/components/schemas/CarePlanDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Plan Details summary: List CarePlanDetail description: Lists all CarePlanDetail for the given carePlanKey operationId: ListCarePlanDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/details/{carePlanDetailKey}': get: tags: - Care Plan Details summary: Get CarePlanDetail description: Gets CarePlanDetail operationId: GetCarePlanDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanDetailKey in: path description: CarePlanDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Plan Details summary: Update CarePlanDetail description: Updates a specific CarePlanDetail. operationId: UpdateCarePlanDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanDetailKey in: path description: CarePlanDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanDetail' text/json: schema: $ref: '#/components/schemas/CarePlanDetail' application/*+json: schema: $ref: '#/components/schemas/CarePlanDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Plan Details summary: Delete CarePlanDetail description: Deletes an CarePlanDetail operationId: DeleteCarePlanDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanDetailKey in: path description: CarePlanDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/details-batch': put: tags: - Care Plan Details summary: Create or Update Batch CarePlanDetail description: 'Create or Update multiple CarePlanDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCarePlanDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CarePlanDetail' text/json: schema: type: array items: $ref: '#/components/schemas/CarePlanDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/CarePlanDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/rules': post: tags: - Care Plan Rules summary: Create CarePlanRule description: Creates a new CarePlanRule operationId: CreateCarePlanRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanRule' text/json: schema: $ref: '#/components/schemas/CarePlanRule' application/*+json: schema: $ref: '#/components/schemas/CarePlanRule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanRuleVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanRuleVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanRuleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Plan Rules summary: List CarePlanRule description: Lists all CarePlanRule for the given carePlanKey operationId: ListCarePlanRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanRuleListVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanRuleListVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanRuleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/rules/{carePlanRuleKey}': get: tags: - Care Plan Rules summary: Get CarePlanRule description: Gets CarePlanRule operationId: GetCarePlanRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanRuleVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanRuleVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanRuleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Plan Rules summary: Update CarePlanRule description: Updates a specific CarePlanRule. operationId: UpdateCarePlanRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanRule' text/json: schema: $ref: '#/components/schemas/CarePlanRule' application/*+json: schema: $ref: '#/components/schemas/CarePlanRule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanRuleVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanRuleVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanRuleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Plan Rules summary: Delete CarePlanRule description: Deletes an CarePlanRule operationId: DeleteCarePlanRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/rules-batch': put: tags: - Care Plan Rules summary: Create or Update Batch CarePlanRule description: 'Create or Update multiple CarePlanRule at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCarePlanRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CarePlanRule' text/json: schema: type: array items: $ref: '#/components/schemas/CarePlanRule' application/*+json: schema: type: array items: $ref: '#/components/schemas/CarePlanRule' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/rules/{carePlanRuleKey}/criterias': post: tags: - Care Plan Rule Criterias summary: Create CarePlanRuleCriteria description: Creates a new CarePlanRuleCriteria operationId: CreateCarePlanRuleCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanRuleCriteria' text/json: schema: $ref: '#/components/schemas/CarePlanRuleCriteria' application/*+json: schema: $ref: '#/components/schemas/CarePlanRuleCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanRuleCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanRuleCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanRuleCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Plan Rule Criterias summary: List CarePlanRuleCriteria description: Lists all CarePlanRuleCriteria for the given carePlanRuleKey operationId: ListCarePlanRuleCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanRuleCriteriaListVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanRuleCriteriaListVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanRuleCriteriaListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/rules/{carePlanRuleKey}/criterias/{carePlanRuleCriteriaKey}': get: tags: - Care Plan Rule Criterias summary: Get CarePlanRuleCriteria description: Gets CarePlanRuleCriteria operationId: GetCarePlanRuleCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 - name: carePlanRuleCriteriaKey in: path description: CarePlanRuleCriteria Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanRuleCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanRuleCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanRuleCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Plan Rule Criterias summary: Update CarePlanRuleCriteria description: Updates a specific CarePlanRuleCriteria. operationId: UpdateCarePlanRuleCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 - name: carePlanRuleCriteriaKey in: path description: CarePlanRuleCriteria Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanRuleCriteria' text/json: schema: $ref: '#/components/schemas/CarePlanRuleCriteria' application/*+json: schema: $ref: '#/components/schemas/CarePlanRuleCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanRuleCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanRuleCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanRuleCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Plan Rule Criterias summary: Delete CarePlanRuleCriteria description: Deletes an CarePlanRuleCriteria operationId: DeleteCarePlanRuleCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 - name: carePlanRuleCriteriaKey in: path description: CarePlanRuleCriteria Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/rules/{carePlanRuleKey}/criterias-batch': put: tags: - Care Plan Rule Criterias summary: Create or Update Batch CarePlanRuleCriteria description: 'Create or Update multiple CarePlanRuleCriteria at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCarePlanRuleCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CarePlanRuleCriteria' text/json: schema: type: array items: $ref: '#/components/schemas/CarePlanRuleCriteria' application/*+json: schema: type: array items: $ref: '#/components/schemas/CarePlanRuleCriteria' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/rules/{carePlanRuleKey}/details': post: tags: - Care Plan Rule Details summary: Create CarePlanRuleDetail description: Creates a new CarePlanRuleDetail operationId: CreateCarePlanRuleDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanRuleDetail' text/json: schema: $ref: '#/components/schemas/CarePlanRuleDetail' application/*+json: schema: $ref: '#/components/schemas/CarePlanRuleDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanRuleDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanRuleDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanRuleDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Plan Rule Details summary: List CarePlanRuleDetail description: Lists all CarePlanRuleDetail for the given carePlanRuleKey operationId: ListCarePlanRuleDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanRuleDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanRuleDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanRuleDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/rules/{carePlanRuleKey}/details/{carePlanRuleDetailKey}': get: tags: - Care Plan Rule Details summary: Get CarePlanRuleDetail description: Gets CarePlanRuleDetail operationId: GetCarePlanRuleDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 - name: carePlanRuleDetailKey in: path description: CarePlanRuleDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanRuleDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanRuleDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanRuleDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Plan Rule Details summary: Update CarePlanRuleDetail description: Updates a specific CarePlanRuleDetail. operationId: UpdateCarePlanRuleDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 - name: carePlanRuleDetailKey in: path description: CarePlanRuleDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanRuleDetail' text/json: schema: $ref: '#/components/schemas/CarePlanRuleDetail' application/*+json: schema: $ref: '#/components/schemas/CarePlanRuleDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanRuleDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanRuleDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanRuleDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Plan Rule Details summary: Delete CarePlanRuleDetail description: Deletes an CarePlanRuleDetail operationId: DeleteCarePlanRuleDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 - name: carePlanRuleDetailKey in: path description: CarePlanRuleDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/rules/{carePlanRuleKey}/details-batch': put: tags: - Care Plan Rule Details summary: Create or Update Batch CarePlanRuleDetail description: 'Create or Update multiple CarePlanRuleDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCarePlanRuleDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanRuleKey in: path description: CarePlanRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CarePlanRuleDetail' text/json: schema: type: array items: $ref: '#/components/schemas/CarePlanRuleDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/CarePlanRuleDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/scores': post: tags: - Care Plan Scores summary: Create CarePlanScore description: Creates a new CarePlanScore operationId: CreateCarePlanScore parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanScore' text/json: schema: $ref: '#/components/schemas/CarePlanScore' application/*+json: schema: $ref: '#/components/schemas/CarePlanScore' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanScoreVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanScoreVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanScoreVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Plan Scores summary: List CarePlanScore description: Lists all CarePlanScore for the given carePlanKey operationId: ListCarePlanScore parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanScoreListVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanScoreListVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanScoreListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/scores/{carePlanScoreKey}': get: tags: - Care Plan Scores summary: Get CarePlanScore description: Gets CarePlanScore operationId: GetCarePlanScore parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanScoreKey in: path description: CarePlanScore Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanScoreVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanScoreVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanScoreVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Plan Scores summary: Update CarePlanScore description: Updates a specific CarePlanScore. operationId: UpdateCarePlanScore parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanScoreKey in: path description: CarePlanScore Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanScore' text/json: schema: $ref: '#/components/schemas/CarePlanScore' application/*+json: schema: $ref: '#/components/schemas/CarePlanScore' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanScoreVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanScoreVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanScoreVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Plan Scores summary: Delete CarePlanScore description: Deletes an CarePlanScore operationId: DeleteCarePlanScore parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanScoreKey in: path description: CarePlanScore Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/scores-batch': put: tags: - Care Plan Scores summary: Create or Update Batch CarePlanScore description: 'Create or Update multiple CarePlanScore at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCarePlanScore parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CarePlanScore' text/json: schema: type: array items: $ref: '#/components/schemas/CarePlanScore' application/*+json: schema: type: array items: $ref: '#/components/schemas/CarePlanScore' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/scores/{carePlanScoreKey}/details': post: tags: - Care Plan Score Details summary: Create CarePlanScoreDetail description: Creates a new CarePlanScoreDetail operationId: CreateCarePlanScoreDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanScoreKey in: path description: CarePlanScore Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanScoreDetail' text/json: schema: $ref: '#/components/schemas/CarePlanScoreDetail' application/*+json: schema: $ref: '#/components/schemas/CarePlanScoreDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanScoreDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanScoreDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanScoreDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Plan Score Details summary: List CarePlanScoreDetail description: Lists all CarePlanScoreDetail for the given carePlanScoreKey operationId: ListCarePlanScoreDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanScoreKey in: path description: CarePlanScore Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanScoreDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanScoreDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanScoreDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/scores/{carePlanScoreKey}/details/{carePlanScoreDetailKey}': get: tags: - Care Plan Score Details summary: Get CarePlanScoreDetail description: Gets CarePlanScoreDetail operationId: GetCarePlanScoreDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanScoreKey in: path description: CarePlanScore Key required: true schema: type: integer format: int32 - name: carePlanScoreDetailKey in: path description: CarePlanScoreDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanScoreDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanScoreDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanScoreDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Plan Score Details summary: Update CarePlanScoreDetail description: Updates a specific CarePlanScoreDetail. operationId: UpdateCarePlanScoreDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanScoreKey in: path description: CarePlanScore Key required: true schema: type: integer format: int32 - name: carePlanScoreDetailKey in: path description: CarePlanScoreDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CarePlanScoreDetail' text/json: schema: $ref: '#/components/schemas/CarePlanScoreDetail' application/*+json: schema: $ref: '#/components/schemas/CarePlanScoreDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CarePlanScoreDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CarePlanScoreDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CarePlanScoreDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Plan Score Details summary: Delete CarePlanScoreDetail description: Deletes an CarePlanScoreDetail operationId: DeleteCarePlanScoreDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanScoreKey in: path description: CarePlanScore Key required: true schema: type: integer format: int32 - name: carePlanScoreDetailKey in: path description: CarePlanScoreDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-plans/{carePlanKey}/scores/{carePlanScoreKey}/details-batch': put: tags: - Care Plan Score Details summary: Create or Update Batch CarePlanScoreDetail description: 'Create or Update multiple CarePlanScoreDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCarePlanScoreDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carePlanKey in: path description: CarePlan Key required: true schema: type: integer format: int32 - name: carePlanScoreKey in: path description: CarePlanScore Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CarePlanScoreDetail' text/json: schema: type: array items: $ref: '#/components/schemas/CarePlanScoreDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/CarePlanScoreDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-types: post: tags: - Care Types summary: Create CareType description: Creates a new CareType operationId: CreateCareType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareType' text/json: schema: $ref: '#/components/schemas/CareType' application/*+json: schema: $ref: '#/components/schemas/CareType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Types summary: List CareType description: Lists all CareType operationId: ListCareType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-types/{careType}': get: tags: - Care Types summary: Get CareType description: Gets CareType operationId: GetCareType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careType in: path description: Care Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Types summary: Update CareType description: Updates a specific CareType. operationId: UpdateCareType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careType in: path description: Care Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareType' text/json: schema: $ref: '#/components/schemas/CareType' application/*+json: schema: $ref: '#/components/schemas/CareType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CareTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CareTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Types summary: Delete CareType description: Deletes an CareType operationId: DeleteCareType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careType in: path description: Care Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-types-batch: put: tags: - Care Types summary: Create or Update Batch CareType description: 'Create or Update multiple CareType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareType' text/json: schema: type: array items: $ref: '#/components/schemas/CareType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-units: post: tags: - Care Units summary: Create CareUnit description: Creates a new CareUnit operationId: CreateCareUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CareUnit' text/json: schema: $ref: '#/components/schemas/CareUnit' application/*+json: schema: $ref: '#/components/schemas/CareUnit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/CareUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/CareUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Units summary: List CareUnit description: Lists all CareUnit operationId: ListCareUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareUnitListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareUnitListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareUnitListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-units/{careUnitKey}': get: tags: - Care Units summary: Get CareUnit description: Gets CareUnit operationId: GetCareUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careUnitKey in: path description: CareUnit Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/CareUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/CareUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Units summary: Update CareUnit description: Updates a specific CareUnit. operationId: UpdateCareUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careUnitKey in: path description: CareUnit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareUnit' text/json: schema: $ref: '#/components/schemas/CareUnit' application/*+json: schema: $ref: '#/components/schemas/CareUnit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/CareUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/CareUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Units summary: Delete CareUnit description: Deletes an CareUnit operationId: DeleteCareUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careUnitKey in: path description: CareUnit Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /care-units-batch: put: tags: - Care Units summary: Create or Update Batch CareUnit description: 'Create or Update multiple CareUnit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareUnit' text/json: schema: type: array items: $ref: '#/components/schemas/CareUnit' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareUnit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-units/{careUnitKey}/managers': post: tags: - Care Unit Managers summary: Create CareUnitCareManager description: Creates a new CareUnitCareManager operationId: CreateCareUnitCareManager parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careUnitKey in: path description: CareUnit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareUnitCareManager' text/json: schema: $ref: '#/components/schemas/CareUnitCareManager' application/*+json: schema: $ref: '#/components/schemas/CareUnitCareManager' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareUnitCareManagerVBAResponse' application/json: schema: $ref: '#/components/schemas/CareUnitCareManagerVBAResponse' text/json: schema: $ref: '#/components/schemas/CareUnitCareManagerVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Care Unit Managers summary: List CareUnitCareManager description: Lists all CareUnitCareManager for the given careUnitKey operationId: ListCareUnitCareManager parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careUnitKey in: path description: CareUnit Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareUnitCareManagerListVBAResponse' application/json: schema: $ref: '#/components/schemas/CareUnitCareManagerListVBAResponse' text/json: schema: $ref: '#/components/schemas/CareUnitCareManagerListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-units/{careUnitKey}/managers/{careManagerKey}': get: tags: - Care Unit Managers summary: Get CareUnitCareManager description: Gets CareUnitCareManager operationId: GetCareUnitCareManager parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careUnitKey in: path description: CareUnit Key required: true schema: type: integer format: int32 - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareUnitCareManagerVBAResponse' application/json: schema: $ref: '#/components/schemas/CareUnitCareManagerVBAResponse' text/json: schema: $ref: '#/components/schemas/CareUnitCareManagerVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Care Unit Managers summary: Update CareUnitCareManager description: Updates a specific CareUnitCareManager. operationId: UpdateCareUnitCareManager parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careUnitKey in: path description: CareUnit Key required: true schema: type: integer format: int32 - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CareUnitCareManager' text/json: schema: $ref: '#/components/schemas/CareUnitCareManager' application/*+json: schema: $ref: '#/components/schemas/CareUnitCareManager' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CareUnitCareManagerVBAResponse' application/json: schema: $ref: '#/components/schemas/CareUnitCareManagerVBAResponse' text/json: schema: $ref: '#/components/schemas/CareUnitCareManagerVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Care Unit Managers summary: Delete CareUnitCareManager description: Deletes an CareUnitCareManager operationId: DeleteCareUnitCareManager parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careUnitKey in: path description: CareUnit Key required: true schema: type: integer format: int32 - name: careManagerKey in: path description: CareManager Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/care-units/{careUnitKey}/managers-batch': put: tags: - Care Unit Managers summary: Create or Update Batch CareUnitCareManager description: 'Create or Update multiple CareUnitCareManager at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCareUnitCareManager parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: careUnitKey in: path description: CareUnit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CareUnitCareManager' text/json: schema: type: array items: $ref: '#/components/schemas/CareUnitCareManager' application/*+json: schema: type: array items: $ref: '#/components/schemas/CareUnitCareManager' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-attachments: post: tags: - Case Attachments summary: Create CaseAttachment description: Creates a new CaseAttachment operationId: CreateCaseAttachment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseAttachment' text/json: schema: $ref: '#/components/schemas/CaseAttachment' application/*+json: schema: $ref: '#/components/schemas/CaseAttachment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseAttachmentVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseAttachmentVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseAttachmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Case Attachments summary: List CaseAttachment description: Lists all CaseAttachment operationId: ListCaseAttachment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseAttachmentListVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseAttachmentListVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseAttachmentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/case-attachments/{CaseAttachment_Key}': get: tags: - Case Attachments summary: Get CaseAttachment description: Gets CaseAttachment operationId: GetCaseAttachment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CaseAttachment_Key in: path description: CaseAttachment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseAttachmentVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseAttachmentVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseAttachmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Case Attachments summary: Update CaseAttachment description: Updates a specific CaseAttachment. operationId: UpdateCaseAttachment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CaseAttachment_Key in: path description: CaseAttachment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseAttachment' text/json: schema: $ref: '#/components/schemas/CaseAttachment' application/*+json: schema: $ref: '#/components/schemas/CaseAttachment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseAttachmentVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseAttachmentVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseAttachmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Case Attachments summary: Delete CaseAttachment description: Deletes an CaseAttachment operationId: DeleteCaseAttachment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CaseAttachment_Key in: path description: CaseAttachment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-attachments-batch: put: tags: - Case Attachments summary: Create or Update Batch CaseAttachment description: 'Create or Update multiple CaseAttachment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCaseAttachment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CaseAttachment' text/json: schema: type: array items: $ref: '#/components/schemas/CaseAttachment' application/*+json: schema: type: array items: $ref: '#/components/schemas/CaseAttachment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-attachment-types: post: tags: - Case Attachment Types summary: Create CaseAttachmentType description: Creates a new CaseAttachmentType operationId: CreateCaseAttachmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseAttachmentType' text/json: schema: $ref: '#/components/schemas/CaseAttachmentType' application/*+json: schema: $ref: '#/components/schemas/CaseAttachmentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseAttachmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseAttachmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseAttachmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Case Attachment Types summary: List CaseAttachmentType description: Lists all CaseAttachmentType operationId: ListCaseAttachmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseAttachmentTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseAttachmentTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseAttachmentTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/case-attachment-types/{caseAttachmentTypeKey}': get: tags: - Case Attachment Types summary: Get CaseAttachmentType description: Gets CaseAttachmentType operationId: GetCaseAttachmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseAttachmentTypeKey in: path description: CaseAttachmentType Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseAttachmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseAttachmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseAttachmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Case Attachment Types summary: Update CaseAttachmentType description: Updates a specific CaseAttachmentType. operationId: UpdateCaseAttachmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseAttachmentTypeKey in: path description: CaseAttachmentType Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseAttachmentType' text/json: schema: $ref: '#/components/schemas/CaseAttachmentType' application/*+json: schema: $ref: '#/components/schemas/CaseAttachmentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseAttachmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseAttachmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseAttachmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Case Attachment Types summary: Delete CaseAttachmentType description: Deletes an CaseAttachmentType operationId: DeleteCaseAttachmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseAttachmentTypeKey in: path description: CaseAttachmentType Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-attachment-types-batch: put: tags: - Case Attachment Types summary: Create or Update Batch CaseAttachmentType description: 'Create or Update multiple CaseAttachmentType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCaseAttachmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CaseAttachmentType' text/json: schema: type: array items: $ref: '#/components/schemas/CaseAttachmentType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CaseAttachmentType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-close-reasons: post: tags: - Case Close Reasons summary: Create CaseCloseReason description: Creates a new CaseCloseReason operationId: CreateCaseCloseReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseCloseReason' text/json: schema: $ref: '#/components/schemas/CaseCloseReason' application/*+json: schema: $ref: '#/components/schemas/CaseCloseReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseCloseReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseCloseReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseCloseReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Case Close Reasons summary: List CaseCloseReason description: Lists all CaseCloseReason operationId: ListCaseCloseReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseCloseReasonListVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseCloseReasonListVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseCloseReasonListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/case-close-reasons/{caseCloseReason}': get: tags: - Case Close Reasons summary: Get CaseCloseReason description: Gets CaseCloseReason operationId: GetCaseCloseReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseCloseReason in: path description: Case Close Reason required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseCloseReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseCloseReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseCloseReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Case Close Reasons summary: Update CaseCloseReason description: Updates a specific CaseCloseReason. operationId: UpdateCaseCloseReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseCloseReason in: path description: Case Close Reason required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseCloseReason' text/json: schema: $ref: '#/components/schemas/CaseCloseReason' application/*+json: schema: $ref: '#/components/schemas/CaseCloseReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseCloseReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseCloseReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseCloseReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Case Close Reasons summary: Delete CaseCloseReason description: Deletes an CaseCloseReason operationId: DeleteCaseCloseReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseCloseReason in: path description: Case Close Reason required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-close-reasons-batch: put: tags: - Case Close Reasons summary: Create or Update Batch CaseCloseReason description: 'Create or Update multiple CaseCloseReason at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCaseCloseReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CaseCloseReason' text/json: schema: type: array items: $ref: '#/components/schemas/CaseCloseReason' application/*+json: schema: type: array items: $ref: '#/components/schemas/CaseCloseReason' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-heads: post: tags: - Case Heads summary: Create CaseHead description: Creates a new CaseHead operationId: CreateCaseHead parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseHead' text/json: schema: $ref: '#/components/schemas/CaseHead' application/*+json: schema: $ref: '#/components/schemas/CaseHead' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseHeadVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseHeadVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseHeadVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Case Heads summary: List CaseHead description: Lists all CaseHead operationId: ListCaseHead parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseHeadListVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseHeadListVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseHeadListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/case-heads/{caseHeadKey}': get: tags: - Case Heads summary: Get CaseHead description: Gets CaseHead operationId: GetCaseHead parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseHeadKey in: path description: CaseHead Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseHeadVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseHeadVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseHeadVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Case Heads summary: Update CaseHead description: Updates a specific CaseHead. operationId: UpdateCaseHead parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseHeadKey in: path description: CaseHead Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseHead' text/json: schema: $ref: '#/components/schemas/CaseHead' application/*+json: schema: $ref: '#/components/schemas/CaseHead' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseHeadVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseHeadVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseHeadVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Case Heads summary: Delete CaseHead description: Deletes an CaseHead operationId: DeleteCaseHead parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseHeadKey in: path description: CaseHead Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-heads-batch: put: tags: - Case Heads summary: Create or Update Batch CaseHead description: 'Create or Update multiple CaseHead at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCaseHead parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CaseHead' text/json: schema: type: array items: $ref: '#/components/schemas/CaseHead' application/*+json: schema: type: array items: $ref: '#/components/schemas/CaseHead' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-head-types: post: tags: - Case Head Types summary: Create CaseHeadType description: Creates a new CaseHeadType operationId: CreateCaseHeadType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseHeadType' text/json: schema: $ref: '#/components/schemas/CaseHeadType' application/*+json: schema: $ref: '#/components/schemas/CaseHeadType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseHeadTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseHeadTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseHeadTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Case Head Types summary: List CaseHeadType description: Lists all CaseHeadType operationId: ListCaseHeadType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseHeadTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseHeadTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseHeadTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/case-head-types/{caseHeadType}': get: tags: - Case Head Types summary: Get CaseHeadType description: Gets CaseHeadType operationId: GetCaseHeadType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseHeadType in: path description: CaseHead Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseHeadTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseHeadTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseHeadTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Case Head Types summary: Update CaseHeadType description: Updates a specific CaseHeadType. operationId: UpdateCaseHeadType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseHeadType in: path description: CaseHead Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseHeadType' text/json: schema: $ref: '#/components/schemas/CaseHeadType' application/*+json: schema: $ref: '#/components/schemas/CaseHeadType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseHeadTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseHeadTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseHeadTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Case Head Types summary: Delete CaseHeadType description: Deletes an CaseHeadType operationId: DeleteCaseHeadType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseHeadType in: path description: CaseHead Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-head-types-batch: put: tags: - Case Head Types summary: Create or Update Batch CaseHeadType description: 'Create or Update multiple CaseHeadType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCaseHeadType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CaseHeadType' text/json: schema: type: array items: $ref: '#/components/schemas/CaseHeadType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CaseHeadType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-medical-concordance-levels: post: tags: - Case Medical Concordance Levels summary: Create CaseMedicalConcordanceLevel description: Creates a new CaseMedicalConcordanceLevel operationId: CreateCaseMedicalConcordanceLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevel' text/json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevel' application/*+json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevel' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevelVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevelVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevelVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Case Medical Concordance Levels summary: List CaseMedicalConcordanceLevel description: Lists all CaseMedicalConcordanceLevel operationId: ListCaseMedicalConcordanceLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevelListVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevelListVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevelListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/case-medical-concordance-levels/{medicalConcordanceLevel}': get: tags: - Case Medical Concordance Levels summary: Get CaseMedicalConcordanceLevel description: Gets CaseMedicalConcordanceLevel operationId: GetCaseMedicalConcordanceLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: medicalConcordanceLevel in: path description: Medical Concordance Level required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevelVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevelVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevelVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Case Medical Concordance Levels summary: Update CaseMedicalConcordanceLevel description: Updates a specific CaseMedicalConcordanceLevel. operationId: UpdateCaseMedicalConcordanceLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: medicalConcordanceLevel in: path description: Medical Concordance Level required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevel' text/json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevel' application/*+json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevel' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevelVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevelVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseMedicalConcordanceLevelVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Case Medical Concordance Levels summary: Delete CaseMedicalConcordanceLevel description: Deletes an CaseMedicalConcordanceLevel operationId: DeleteCaseMedicalConcordanceLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: medicalConcordanceLevel in: path description: Medical Concordance Level required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-medical-concordance-levels-batch: put: tags: - Case Medical Concordance Levels summary: Create or Update Batch CaseMedicalConcordanceLevel description: 'Create or Update multiple CaseMedicalConcordanceLevel at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCaseMedicalConcordanceLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CaseMedicalConcordanceLevel' text/json: schema: type: array items: $ref: '#/components/schemas/CaseMedicalConcordanceLevel' application/*+json: schema: type: array items: $ref: '#/components/schemas/CaseMedicalConcordanceLevel' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-priorities: post: tags: - Case Priorities summary: Create CasePriority description: Creates a new CasePriority operationId: CreateCasePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CasePriority' text/json: schema: $ref: '#/components/schemas/CasePriority' application/*+json: schema: $ref: '#/components/schemas/CasePriority' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CasePriorityVBAResponse' application/json: schema: $ref: '#/components/schemas/CasePriorityVBAResponse' text/json: schema: $ref: '#/components/schemas/CasePriorityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Case Priorities summary: List CasePriority description: Lists all CasePriority operationId: ListCasePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CasePriorityListVBAResponse' application/json: schema: $ref: '#/components/schemas/CasePriorityListVBAResponse' text/json: schema: $ref: '#/components/schemas/CasePriorityListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/case-priorities/{casePriority}': get: tags: - Case Priorities summary: Get CasePriority description: Gets CasePriority operationId: GetCasePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: casePriority in: path description: Case Priority required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CasePriorityVBAResponse' application/json: schema: $ref: '#/components/schemas/CasePriorityVBAResponse' text/json: schema: $ref: '#/components/schemas/CasePriorityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Case Priorities summary: Update CasePriority description: Updates a specific CasePriority. operationId: UpdateCasePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: casePriority in: path description: Case Priority required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CasePriority' text/json: schema: $ref: '#/components/schemas/CasePriority' application/*+json: schema: $ref: '#/components/schemas/CasePriority' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CasePriorityVBAResponse' application/json: schema: $ref: '#/components/schemas/CasePriorityVBAResponse' text/json: schema: $ref: '#/components/schemas/CasePriorityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Case Priorities summary: Delete CasePriority description: Deletes an CasePriority operationId: DeleteCasePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: casePriority in: path description: Case Priority required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-priorities-batch: put: tags: - Case Priorities summary: Create or Update Batch CasePriority description: 'Create or Update multiple CasePriority at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCasePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CasePriority' text/json: schema: type: array items: $ref: '#/components/schemas/CasePriority' application/*+json: schema: type: array items: $ref: '#/components/schemas/CasePriority' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-reasons: post: tags: - Case Reasons summary: Create CaseReason description: Creates a new CaseReason operationId: CreateCaseReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseReason' text/json: schema: $ref: '#/components/schemas/CaseReason' application/*+json: schema: $ref: '#/components/schemas/CaseReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Case Reasons summary: List CaseReason description: Lists all CaseReason operationId: ListCaseReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseReasonListVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseReasonListVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseReasonListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/case-reasons/{caseReason}': get: tags: - Case Reasons summary: Get CaseReason description: Gets CaseReason operationId: GetCaseReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseReason in: path description: Case Reason required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Case Reasons summary: Update CaseReason description: Updates a specific CaseReason. operationId: UpdateCaseReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseReason in: path description: Case Reason required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseReason' text/json: schema: $ref: '#/components/schemas/CaseReason' application/*+json: schema: $ref: '#/components/schemas/CaseReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Case Reasons summary: Delete CaseReason description: Deletes an CaseReason operationId: DeleteCaseReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseReason in: path description: Case Reason required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-reasons-batch: put: tags: - Case Reasons summary: Create or Update Batch CaseReason description: 'Create or Update multiple CaseReason at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCaseReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CaseReason' text/json: schema: type: array items: $ref: '#/components/schemas/CaseReason' application/*+json: schema: type: array items: $ref: '#/components/schemas/CaseReason' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-statuses: post: tags: - Case Statuses summary: Create CaseStatus description: Creates a new CaseStatus operationId: CreateCaseStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseStatus' text/json: schema: $ref: '#/components/schemas/CaseStatus' application/*+json: schema: $ref: '#/components/schemas/CaseStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Case Statuses summary: List CaseStatus description: Lists all CaseStatus operationId: ListCaseStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/case-statuses/{caseStatus}': get: tags: - Case Statuses summary: Get CaseStatus description: Gets CaseStatus operationId: GetCaseStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseStatus in: path description: Case Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Case Statuses summary: Update CaseStatus description: Updates a specific CaseStatus. operationId: UpdateCaseStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseStatus in: path description: Case Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseStatus' text/json: schema: $ref: '#/components/schemas/CaseStatus' application/*+json: schema: $ref: '#/components/schemas/CaseStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Case Statuses summary: Delete CaseStatus description: Deletes an CaseStatus operationId: DeleteCaseStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseStatus in: path description: Case Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-statuses-batch: put: tags: - Case Statuses summary: Create or Update Batch CaseStatus description: 'Create or Update multiple CaseStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCaseStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CaseStatus' text/json: schema: type: array items: $ref: '#/components/schemas/CaseStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/CaseStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-status-reasons: post: tags: - Case Status Reasons summary: Create CaseStatusReason description: Creates a new CaseStatusReason operationId: CreateCaseStatusReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseStatusReason' text/json: schema: $ref: '#/components/schemas/CaseStatusReason' application/*+json: schema: $ref: '#/components/schemas/CaseStatusReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseStatusReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseStatusReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseStatusReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Case Status Reasons summary: List CaseStatusReason description: Lists all CaseStatusReason operationId: ListCaseStatusReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseStatusReasonListVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseStatusReasonListVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseStatusReasonListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/case-status-reasons/{caseStatusReason}': get: tags: - Case Status Reasons summary: Get CaseStatusReason description: Gets CaseStatusReason operationId: GetCaseStatusReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseStatusReason in: path description: Case Status Reason required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseStatusReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseStatusReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseStatusReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Case Status Reasons summary: Update CaseStatusReason description: Updates a specific CaseStatusReason. operationId: UpdateCaseStatusReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseStatusReason in: path description: Case Status Reason required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseStatusReason' text/json: schema: $ref: '#/components/schemas/CaseStatusReason' application/*+json: schema: $ref: '#/components/schemas/CaseStatusReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CaseStatusReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CaseStatusReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CaseStatusReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Case Status Reasons summary: Delete CaseStatusReason description: Deletes an CaseStatusReason operationId: DeleteCaseStatusReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseStatusReason in: path description: Case Status Reason required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /case-status-reasons-batch: put: tags: - Case Status Reasons summary: Create or Update Batch CaseStatusReason description: 'Create or Update multiple CaseStatusReason at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCaseStatusReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CaseStatusReason' text/json: schema: type: array items: $ref: '#/components/schemas/CaseStatusReason' application/*+json: schema: type: array items: $ref: '#/components/schemas/CaseStatusReason' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /cdc-subscribers: get: tags: - Change Data Capture summary: List Subscribers CDC description: Lists all Change Data Capture information for the Subscribers table. operationId: ListCDCSubscribers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberId in: query description: Send a specific Subscriber ID to look up changes or pass no value and get all changes. schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_CDC_SubscribersListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_CDC_SubscribersListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_CDC_SubscribersListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /cdc-members: get: tags: - Change Data Capture summary: List Members CDC description: Lists all Change Data Capture information for the Members table. operationId: ListCDCMembers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberId in: query description: Send a specific Subscriber ID/Member Seq to look up changes or pass no value and get all changes. schema: type: string - name: memberSeq in: query description: Send a specific Subscriber ID/Member Seq to look up changes or pass no value and get all changes. schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_CDC_MembersListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_CDC_MembersListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_CDC_MembersListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /cdc-subenrollment: get: tags: - Change Data Capture summary: List Subenrollment CDC description: Lists all Change Data Capture information for the Subenrollment table. operationId: ListCDCSubenrollment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberId in: query description: Send a specific Subscriber ID to look up changes or pass no value and get all changes. schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_CDC_SubenrollmentListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_CDC_SubenrollmentListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_CDC_SubenrollmentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /cdc-subenrollmentplan: get: tags: - Change Data Capture summary: List SubenrollmentPlan CDC description: Lists all Change Data Capture information for the SubenrollmentPlan table. operationId: ListCDCSubenrollmentPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberId in: query description: Send a specific Subscriber ID to look up changes or pass no value and get all changes. schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_CDC_SubenrollmentPlanListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_CDC_SubenrollmentPlanListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_CDC_SubenrollmentPlanListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /cdc-subenrollmentrider: get: tags: - Change Data Capture summary: List SubenrollmentRider CDC description: Lists all Change Data Capture information for the SubenrollmentRider table. operationId: ListCDCSubenrollmentRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberId in: query description: Send a specific Subscriber ID to look up changes or pass no value and get all changes. schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_CDC_SubenrollmentRiderListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_CDC_SubenrollmentRiderListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_CDC_SubenrollmentRiderListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /chat: post: tags: - VBAssist summary: Talk with VBAssist description: An interactive client for VBAssist operationId: ChatRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/ChatMessage' text/json: schema: $ref: '#/components/schemas/ChatMessage' application/*+json: schema: $ref: '#/components/schemas/ChatMessage' responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /check-batches: post: tags: - Check Batches summary: Create CheckBatch description: Creates a new CheckBatch operationId: CreateCheckBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckBatch' text/json: schema: $ref: '#/components/schemas/CheckBatch' application/*+json: schema: $ref: '#/components/schemas/CheckBatch' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckBatchVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckBatchVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckBatchVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Check Batches summary: List CheckBatch description: Lists all CheckBatch operationId: ListCheckBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckBatchListVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckBatchListVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckBatchListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/check-batches/{checkBatch}': get: tags: - Check Batches summary: Get CheckBatch description: Gets CheckBatch operationId: GetCheckBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkBatch in: path description: Check Batch required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckBatchVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckBatchVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckBatchVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Check Batches summary: Update CheckBatch description: Updates a specific CheckBatch. operationId: UpdateCheckBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkBatch in: path description: Check Batch required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckBatch' text/json: schema: $ref: '#/components/schemas/CheckBatch' application/*+json: schema: $ref: '#/components/schemas/CheckBatch' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckBatchVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckBatchVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckBatchVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Check Batches summary: Delete CheckBatch description: Deletes an CheckBatch operationId: DeleteCheckBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkBatch in: path description: Check Batch required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /check-batches-batch: put: tags: - Check Batches summary: Create or Update Batch CheckBatch description: 'Create or Update multiple CheckBatch at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCheckBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CheckBatch' text/json: schema: type: array items: $ref: '#/components/schemas/CheckBatch' application/*+json: schema: type: array items: $ref: '#/components/schemas/CheckBatch' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/check-batches-check-edit/{checkBatch}': put: tags: - Check Batches summary: CheckBatch CheckEdit description: Runs all configured check edits based on Check Batch and returns the results of those edits. operationId: CheckBatchCheckEdit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkBatch in: path description: Check Batch required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckEditResultListVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckEditResultListVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckEditResultListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /check-edits: get: tags: - Check Edits summary: List CheckEdit description: Lists all CheckEdit operationId: ListCheckEdit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckEditListVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckEditListVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckEditListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/check-edits/{checkEditKey}': get: tags: - Check Edits summary: Get CheckEdit description: Gets CheckEdit operationId: GetCheckEdit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkEditKey in: path description: CheckEdit Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckEditVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckEditVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckEditVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/check-edit-details/{checkEditSetHeaderKey}/{checkEditKey}': post: tags: - Check Edit Details summary: Create CheckEditSetDetail description: Creates a new CheckEditSetDetail operationId: CreateCheckEditSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkEditSetHeaderKey in: path description: CheckEditSetHeader Key required: true schema: type: integer format: int32 - name: checkEditKey in: path description: CheckEdit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckEditSetDetail' text/json: schema: $ref: '#/components/schemas/CheckEditSetDetail' application/*+json: schema: $ref: '#/components/schemas/CheckEditSetDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckEditSetDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckEditSetDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckEditSetDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Check Edit Details summary: Get CheckEditSetDetail description: Gets CheckEditSetDetail operationId: GetCheckEditSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkEditSetHeaderKey in: path description: CheckEditSetHeader Key required: true schema: type: integer format: int32 - name: checkEditKey in: path description: CheckEdit Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckEditSetDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckEditSetDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckEditSetDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Check Edit Details summary: Update CheckEditSetDetail description: Updates a specific CheckEditSetDetail. operationId: UpdateCheckEditSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkEditSetHeaderKey in: path description: CheckEditSetHeader Key required: true schema: type: integer format: int32 - name: checkEditKey in: path description: CheckEdit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckEditSetDetail' text/json: schema: $ref: '#/components/schemas/CheckEditSetDetail' application/*+json: schema: $ref: '#/components/schemas/CheckEditSetDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckEditSetDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckEditSetDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckEditSetDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Check Edit Details summary: Delete CheckEditSetDetail description: Deletes an CheckEditSetDetail operationId: DeleteCheckEditSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkEditSetHeaderKey in: path description: CheckEditSetHeader Key required: true schema: type: integer format: int32 - name: checkEditKey in: path description: CheckEdit Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /check-edit-details: get: tags: - Check Edit Details summary: List CheckEditSetDetail description: Lists all CheckEditSetDetail operationId: ListCheckEditSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckEditSetDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckEditSetDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckEditSetDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /check-edit-details-batch: put: tags: - Check Edit Details summary: Create or Update Batch CheckEditSetDetail description: 'Create or Update multiple CheckEditSetDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCheckEditSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CheckEditSetDetail' text/json: schema: type: array items: $ref: '#/components/schemas/CheckEditSetDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/CheckEditSetDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /check-edit-headers: get: tags: - Check Edit Headers summary: List CheckEditSetHeader description: Lists all CheckEditSetHeader operationId: ListCheckEditSetHeader parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckEditSetHeaderListVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckEditSetHeaderListVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckEditSetHeaderListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/check-edit-headers/{checkEditSetHeaderKey}': get: tags: - Check Edit Headers summary: Get CheckEditSetHeader description: Gets CheckEditSetHeader operationId: GetCheckEditSetHeader parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkEditSetHeaderKey in: path description: CheckEditSetHeader Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckEditSetHeaderVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckEditSetHeaderVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckEditSetHeaderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /checks: post: tags: - Checks summary: Create Checks description: Creates a new Checks operationId: CreateChecks parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Checks' text/json: schema: $ref: '#/components/schemas/Checks' application/*+json: schema: $ref: '#/components/schemas/Checks' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ChecksVBAResponse' application/json: schema: $ref: '#/components/schemas/ChecksVBAResponse' text/json: schema: $ref: '#/components/schemas/ChecksVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Checks summary: List Checks description: Lists all Checks operationId: ListChecks parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ChecksListVBAResponse' application/json: schema: $ref: '#/components/schemas/ChecksListVBAResponse' text/json: schema: $ref: '#/components/schemas/ChecksListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/checks/{checkID}/void': post: tags: - Checks - Adv. Accounting summary: Void Check description: Voids an existing Check operationId: VoidCheck parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkID in: path description: Check ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingVoidCheck' text/json: schema: $ref: '#/components/schemas/FundingVoidCheck' application/*+json: schema: $ref: '#/components/schemas/FundingVoidCheck' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ChecksVBAResponse' application/json: schema: $ref: '#/components/schemas/ChecksVBAResponse' text/json: schema: $ref: '#/components/schemas/ChecksVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /checks-name-on-check: post: tags: - Checks - Adv. Accounting summary: Get Name and Address Information description: 'Using Send Check To and a dynamic Pay To ID, get the delivery information for a potential check.' operationId: GetNameOnCheck parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingNameOnCheck' text/json: schema: $ref: '#/components/schemas/FundingNameOnCheck' application/*+json: schema: $ref: '#/components/schemas/FundingNameOnCheck' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingNameOnCheckVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingNameOnCheckVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingNameOnCheckVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/checks/{checkID}': get: tags: - Checks summary: Get Checks description: Gets Checks operationId: GetChecks parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkID in: path description: Check ID required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ChecksVBAResponse' application/json: schema: $ref: '#/components/schemas/ChecksVBAResponse' text/json: schema: $ref: '#/components/schemas/ChecksVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Checks summary: Update Checks description: Updates a specific Checks. operationId: UpdateChecks parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkID in: path description: Check ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Checks' text/json: schema: $ref: '#/components/schemas/Checks' application/*+json: schema: $ref: '#/components/schemas/Checks' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ChecksVBAResponse' application/json: schema: $ref: '#/components/schemas/ChecksVBAResponse' text/json: schema: $ref: '#/components/schemas/ChecksVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Checks summary: Delete Checks description: Deletes an Checks operationId: DeleteChecks parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkID in: path description: Check ID required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /checks-batch: put: tags: - Checks summary: Create or Update Batch Checks description: 'Create or Update multiple Checks at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchChecks parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Checks' text/json: schema: type: array items: $ref: '#/components/schemas/Checks' application/*+json: schema: type: array items: $ref: '#/components/schemas/Checks' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /checks-process: post: tags: - Checks - Adv. Accounting summary: Process Checks description: 'Initiates the process of Check Processing. If the request is valid, the system will generate the necessary actions to process checks and respond with a success status code of 202 Accepted, along with the generated process key.' operationId: ProcessChecks parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingProcessCheck' text/json: schema: $ref: '#/components/schemas/FundingProcessCheck' application/*+json: schema: $ref: '#/components/schemas/FundingProcessCheck' required: true responses: '202': description: 'Accepted for processing, returns the generated process key' content: text/plain: schema: $ref: '#/components/schemas/Int32VBAResponse' application/json: schema: $ref: '#/components/schemas/Int32VBAResponse' text/json: schema: $ref: '#/components/schemas/Int32VBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/checks/{checkID}/details': post: tags: - Check Details summary: Create ChecksDetail description: Creates a new ChecksDetail operationId: CreateChecksDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkID in: path description: Check ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ChecksDetail' text/json: schema: $ref: '#/components/schemas/ChecksDetail' application/*+json: schema: $ref: '#/components/schemas/ChecksDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ChecksDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ChecksDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ChecksDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Check Details summary: List ChecksDetail description: Lists all ChecksDetail for the given checkID operationId: ListChecksDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkID in: path description: Check ID required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ChecksDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ChecksDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ChecksDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/checks/{checkID}/details/{itemSeq}': get: tags: - Check Details summary: Get ChecksDetail description: Gets ChecksDetail operationId: GetChecksDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkID in: path description: Check ID required: true schema: type: integer format: int32 - name: itemSeq in: path description: Item Seq required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ChecksDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ChecksDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ChecksDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Check Details summary: Update ChecksDetail description: Updates a specific ChecksDetail. operationId: UpdateChecksDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkID in: path description: Check ID required: true schema: type: integer format: int32 - name: itemSeq in: path description: Item Seq required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ChecksDetail' text/json: schema: $ref: '#/components/schemas/ChecksDetail' application/*+json: schema: $ref: '#/components/schemas/ChecksDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ChecksDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ChecksDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ChecksDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Check Details summary: Delete ChecksDetail description: Deletes an ChecksDetail operationId: DeleteChecksDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkID in: path description: Check ID required: true schema: type: integer format: int32 - name: itemSeq in: path description: Item Seq required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/checks/{checkID}/details-batch': put: tags: - Check Details summary: Create or Update Batch ChecksDetail description: 'Create or Update multiple ChecksDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchChecksDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkID in: path description: Check ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ChecksDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ChecksDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ChecksDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /check-statuses: post: tags: - Check Statuses summary: Create CheckStatus description: Creates a new CheckStatus operationId: CreateCheckStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckStatus' text/json: schema: $ref: '#/components/schemas/CheckStatus' application/*+json: schema: $ref: '#/components/schemas/CheckStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Check Statuses summary: List CheckStatus description: Lists all CheckStatus operationId: ListCheckStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/check-statuses/{checkStatus}': get: tags: - Check Statuses summary: Get CheckStatus description: Gets CheckStatus operationId: GetCheckStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkStatus in: path description: Check Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Check Statuses summary: Update CheckStatus description: Updates a specific CheckStatus. operationId: UpdateCheckStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkStatus in: path description: Check Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckStatus' text/json: schema: $ref: '#/components/schemas/CheckStatus' application/*+json: schema: $ref: '#/components/schemas/CheckStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Check Statuses summary: Delete CheckStatus description: Deletes an CheckStatus operationId: DeleteCheckStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkStatus in: path description: Check Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /check-statuses-batch: put: tags: - Check Statuses summary: Create or Update Batch CheckStatus description: 'Create or Update multiple CheckStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCheckStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CheckStatus' text/json: schema: type: array items: $ref: '#/components/schemas/CheckStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/CheckStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /check-types: post: tags: - Check Types summary: Create CheckType description: Creates a new CheckType operationId: CreateCheckType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckType' text/json: schema: $ref: '#/components/schemas/CheckType' application/*+json: schema: $ref: '#/components/schemas/CheckType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Check Types summary: List CheckType description: Lists all CheckType operationId: ListCheckType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/check-types/{checkType}': get: tags: - Check Types summary: Get CheckType description: Gets CheckType operationId: GetCheckType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkType in: path description: Check Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Check Types summary: Update CheckType description: Updates a specific CheckType. operationId: UpdateCheckType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkType in: path description: Check Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckType' text/json: schema: $ref: '#/components/schemas/CheckType' application/*+json: schema: $ref: '#/components/schemas/CheckType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CheckTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CheckTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CheckTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Check Types summary: Delete CheckType description: Deletes an CheckType operationId: DeleteCheckType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: checkType in: path description: Check Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /check-types-batch: put: tags: - Check Types summary: Create or Update Batch CheckType description: 'Create or Update multiple CheckType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCheckType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CheckType' text/json: schema: type: array items: $ref: '#/components/schemas/CheckType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CheckType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claims: post: tags: - Claims summary: Create Claim description: Creates a new Claim operationId: CreateClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Claim' text/json: schema: $ref: '#/components/schemas/Claim' application/*+json: schema: $ref: '#/components/schemas/Claim' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claims/{claimNumber}': get: tags: - Claims summary: Get Claim description: Gets Claim operationId: GetClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claims summary: Update Claim description: Updates a specific Claim. operationId: UpdateClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Claim' text/json: schema: $ref: '#/components/schemas/Claim' application/*+json: schema: $ref: '#/components/schemas/Claim' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claims summary: Delete Claim description: Deletes an Claim operationId: DeleteClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claims-batch: put: tags: - Claims summary: Create or Update Batch Claim description: 'Create or Update multiple Claim at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Claim' text/json: schema: type: array items: $ref: '#/components/schemas/Claim' application/*+json: schema: type: array items: $ref: '#/components/schemas/Claim' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-anesthesia-modifier-units: post: tags: - Claim Anesthesia Modifier Units summary: Create ClaimAnesthesiaModifierUnit description: Creates a new ClaimAnesthesiaModifierUnit operationId: CreateClaimAnesthesiaModifierUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnit' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnit' application/*+json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Anesthesia Modifier Units summary: List ClaimAnesthesiaModifierUnit description: Lists all ClaimAnesthesiaModifierUnit operationId: ListClaimAnesthesiaModifierUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnitListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnitListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnitListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-anesthesia-modifier-units/{claimAnesthesiaModifierUnitKey}': get: tags: - Claim Anesthesia Modifier Units summary: Get ClaimAnesthesiaModifierUnit description: Gets ClaimAnesthesiaModifierUnit operationId: GetClaimAnesthesiaModifierUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAnesthesiaModifierUnitKey in: path description: ClaimAnesthesiaModifierUnit Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Anesthesia Modifier Units summary: Update ClaimAnesthesiaModifierUnit description: Updates a specific ClaimAnesthesiaModifierUnit. operationId: UpdateClaimAnesthesiaModifierUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAnesthesiaModifierUnitKey in: path description: ClaimAnesthesiaModifierUnit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnit' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnit' application/*+json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Anesthesia Modifier Units summary: Delete ClaimAnesthesiaModifierUnit description: Deletes an ClaimAnesthesiaModifierUnit operationId: DeleteClaimAnesthesiaModifierUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAnesthesiaModifierUnitKey in: path description: ClaimAnesthesiaModifierUnit Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-anesthesia-modifier-units-batch: put: tags: - Claim Anesthesia Modifier Units summary: Create or Update Batch ClaimAnesthesiaModifierUnit description: 'Create or Update multiple ClaimAnesthesiaModifierUnit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimAnesthesiaModifierUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnit' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnit' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-anesthesia-place-code-units: post: tags: - Claim Anesthesia Place Code Units summary: Create ClaimAnesthesiaPlaceCodeUnit description: Creates a new ClaimAnesthesiaPlaceCodeUnit operationId: CreateClaimAnesthesiaPlaceCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnit' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnit' application/*+json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Anesthesia Place Code Units summary: List ClaimAnesthesiaPlaceCodeUnit description: Lists all ClaimAnesthesiaPlaceCodeUnit operationId: ListClaimAnesthesiaPlaceCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnitListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnitListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnitListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-anesthesia-place-code-units/{claimAnesthesiaPlaceCodeUnitKey}': get: tags: - Claim Anesthesia Place Code Units summary: Get ClaimAnesthesiaPlaceCodeUnit description: Gets ClaimAnesthesiaPlaceCodeUnit operationId: GetClaimAnesthesiaPlaceCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAnesthesiaPlaceCodeUnitKey in: path description: ClaimAnesthesiaPlaceCodeUnit Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Anesthesia Place Code Units summary: Update ClaimAnesthesiaPlaceCodeUnit description: Updates a specific ClaimAnesthesiaPlaceCodeUnit. operationId: UpdateClaimAnesthesiaPlaceCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAnesthesiaPlaceCodeUnitKey in: path description: ClaimAnesthesiaPlaceCodeUnit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnit' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnit' application/*+json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Anesthesia Place Code Units summary: Delete ClaimAnesthesiaPlaceCodeUnit description: Deletes an ClaimAnesthesiaPlaceCodeUnit operationId: DeleteClaimAnesthesiaPlaceCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAnesthesiaPlaceCodeUnitKey in: path description: ClaimAnesthesiaPlaceCodeUnit Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-anesthesia-place-code-units-batch: put: tags: - Claim Anesthesia Place Code Units summary: Create or Update Batch ClaimAnesthesiaPlaceCodeUnit description: 'Create or Update multiple ClaimAnesthesiaPlaceCodeUnit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimAnesthesiaPlaceCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnit' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnit' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-anesthesia-procedure-code-units: post: tags: - Claim Anesthesia Procedure Code Units summary: Create ClaimAnesthesiaProcedureCodeUnit description: Creates a new ClaimAnesthesiaProcedureCodeUnit operationId: CreateClaimAnesthesiaProcedureCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnit' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnit' application/*+json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Anesthesia Procedure Code Units summary: List ClaimAnesthesiaProcedureCodeUnit description: Lists all ClaimAnesthesiaProcedureCodeUnit operationId: ListClaimAnesthesiaProcedureCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnitListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnitListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnitListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-anesthesia-procedure-code-units/{claimAnesthesiaProcedureCodeUnitKey}': get: tags: - Claim Anesthesia Procedure Code Units summary: Get ClaimAnesthesiaProcedureCodeUnit description: Gets ClaimAnesthesiaProcedureCodeUnit operationId: GetClaimAnesthesiaProcedureCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAnesthesiaProcedureCodeUnitKey in: path description: ClaimAnesthesiaProcedureCodeUnit Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Anesthesia Procedure Code Units summary: Update ClaimAnesthesiaProcedureCodeUnit description: Updates a specific ClaimAnesthesiaProcedureCodeUnit. operationId: UpdateClaimAnesthesiaProcedureCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAnesthesiaProcedureCodeUnitKey in: path description: ClaimAnesthesiaProcedureCodeUnit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnit' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnit' application/*+json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Anesthesia Procedure Code Units summary: Delete ClaimAnesthesiaProcedureCodeUnit description: Deletes an ClaimAnesthesiaProcedureCodeUnit operationId: DeleteClaimAnesthesiaProcedureCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAnesthesiaProcedureCodeUnitKey in: path description: ClaimAnesthesiaProcedureCodeUnit Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-anesthesia-procedure-code-units-batch: put: tags: - Claim Anesthesia Procedure Code Units summary: Create or Update Batch ClaimAnesthesiaProcedureCodeUnit description: 'Create or Update multiple ClaimAnesthesiaProcedureCodeUnit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimAnesthesiaProcedureCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnit' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnit' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-audits: post: tags: - Claim Audits summary: Create ClaimAudit description: Creates a new ClaimAudit operationId: CreateClaimAudit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAudit' text/json: schema: $ref: '#/components/schemas/ClaimAudit' application/*+json: schema: $ref: '#/components/schemas/ClaimAudit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Audits summary: List ClaimAudit description: Lists all ClaimAudit operationId: ListClaimAudit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-audits/{claimAuditKey}': get: tags: - Claim Audits summary: Get ClaimAudit description: Gets ClaimAudit operationId: GetClaimAudit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditKey in: path description: ClaimAudit Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Audits summary: Update ClaimAudit description: Updates a specific ClaimAudit. operationId: UpdateClaimAudit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditKey in: path description: ClaimAudit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAudit' text/json: schema: $ref: '#/components/schemas/ClaimAudit' application/*+json: schema: $ref: '#/components/schemas/ClaimAudit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Audits summary: Delete ClaimAudit description: Deletes an ClaimAudit operationId: DeleteClaimAudit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditKey in: path description: ClaimAudit Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-audits-batch: put: tags: - Claim Audits summary: Create or Update Batch ClaimAudit description: 'Create or Update multiple ClaimAudit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimAudit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimAudit' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimAudit' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimAudit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-audit-appeal-reasons: post: tags: - Claim Audit Appeal Reasons summary: Create ClaimAuditAppealReason description: Creates a new ClaimAuditAppealReason operationId: CreateClaimAuditAppealReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAuditAppealReason' text/json: schema: $ref: '#/components/schemas/ClaimAuditAppealReason' application/*+json: schema: $ref: '#/components/schemas/ClaimAuditAppealReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditAppealReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditAppealReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditAppealReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Audit Appeal Reasons summary: List ClaimAuditAppealReason description: Lists all ClaimAuditAppealReason operationId: ListClaimAuditAppealReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditAppealReasonListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditAppealReasonListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditAppealReasonListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-audit-appeal-reasons/{appealReason}': get: tags: - Claim Audit Appeal Reasons summary: Get ClaimAuditAppealReason description: Gets ClaimAuditAppealReason operationId: GetClaimAuditAppealReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: appealReason in: path description: Appeal Reason required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditAppealReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditAppealReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditAppealReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Audit Appeal Reasons summary: Update ClaimAuditAppealReason description: Updates a specific ClaimAuditAppealReason. operationId: UpdateClaimAuditAppealReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: appealReason in: path description: Appeal Reason required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAuditAppealReason' text/json: schema: $ref: '#/components/schemas/ClaimAuditAppealReason' application/*+json: schema: $ref: '#/components/schemas/ClaimAuditAppealReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditAppealReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditAppealReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditAppealReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Audit Appeal Reasons summary: Delete ClaimAuditAppealReason description: Deletes an ClaimAuditAppealReason operationId: DeleteClaimAuditAppealReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: appealReason in: path description: Appeal Reason required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-audit-appeal-reasons-batch: put: tags: - Claim Audit Appeal Reasons summary: Create or Update Batch ClaimAuditAppealReason description: 'Create or Update multiple ClaimAuditAppealReason at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimAuditAppealReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditAppealReason' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditAppealReason' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditAppealReason' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-audit-appeal-results: post: tags: - Claim Audit Appeal Results summary: Create ClaimAuditAppealResult description: Creates a new ClaimAuditAppealResult operationId: CreateClaimAuditAppealResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAuditAppealResult' text/json: schema: $ref: '#/components/schemas/ClaimAuditAppealResult' application/*+json: schema: $ref: '#/components/schemas/ClaimAuditAppealResult' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditAppealResultVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditAppealResultVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditAppealResultVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Audit Appeal Results summary: List ClaimAuditAppealResult description: Lists all ClaimAuditAppealResult operationId: ListClaimAuditAppealResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditAppealResultListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditAppealResultListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditAppealResultListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-audit-appeal-results/{appealResult}': get: tags: - Claim Audit Appeal Results summary: Get ClaimAuditAppealResult description: Gets ClaimAuditAppealResult operationId: GetClaimAuditAppealResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: appealResult in: path description: Appeal Result required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditAppealResultVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditAppealResultVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditAppealResultVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Audit Appeal Results summary: Update ClaimAuditAppealResult description: Updates a specific ClaimAuditAppealResult. operationId: UpdateClaimAuditAppealResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: appealResult in: path description: Appeal Result required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAuditAppealResult' text/json: schema: $ref: '#/components/schemas/ClaimAuditAppealResult' application/*+json: schema: $ref: '#/components/schemas/ClaimAuditAppealResult' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditAppealResultVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditAppealResultVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditAppealResultVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Audit Appeal Results summary: Delete ClaimAuditAppealResult description: Deletes an ClaimAuditAppealResult operationId: DeleteClaimAuditAppealResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: appealResult in: path description: Appeal Result required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-audit-appeal-results-batch: put: tags: - Claim Audit Appeal Results summary: Create or Update Batch ClaimAuditAppealResult description: 'Create or Update multiple ClaimAuditAppealResult at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimAuditAppealResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditAppealResult' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditAppealResult' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditAppealResult' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-audit-clauses: post: tags: - Claim Audit Clauses summary: Create ClaimAuditClause description: Creates a new ClaimAuditClause operationId: CreateClaimAuditClause parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAuditClause' text/json: schema: $ref: '#/components/schemas/ClaimAuditClause' application/*+json: schema: $ref: '#/components/schemas/ClaimAuditClause' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditClauseVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditClauseVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditClauseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Audit Clauses summary: List ClaimAuditClause description: Lists all ClaimAuditClause operationId: ListClaimAuditClause parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditClauseListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditClauseListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditClauseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-audit-clauses/{claimAuditClauseKey}': get: tags: - Claim Audit Clauses summary: Get ClaimAuditClause description: Gets ClaimAuditClause operationId: GetClaimAuditClause parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditClauseKey in: path description: ClaimAuditClause Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditClauseVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditClauseVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditClauseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Audit Clauses summary: Update ClaimAuditClause description: Updates a specific ClaimAuditClause. operationId: UpdateClaimAuditClause parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditClauseKey in: path description: ClaimAuditClause Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAuditClause' text/json: schema: $ref: '#/components/schemas/ClaimAuditClause' application/*+json: schema: $ref: '#/components/schemas/ClaimAuditClause' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditClauseVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditClauseVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditClauseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Audit Clauses summary: Delete ClaimAuditClause description: Deletes an ClaimAuditClause operationId: DeleteClaimAuditClause parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditClauseKey in: path description: ClaimAuditClause Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-audit-clauses-batch: put: tags: - Claim Audit Clauses summary: Create or Update Batch ClaimAuditClause description: 'Create or Update multiple ClaimAuditClause at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimAuditClause parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditClause' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditClause' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditClause' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-audits/{claimAuditKey}/details': post: tags: - Claim Audit Details summary: Create ClaimAuditDetail description: Creates a new ClaimAuditDetail operationId: CreateClaimAuditDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditKey in: path description: ClaimAudit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAuditDetail' text/json: schema: $ref: '#/components/schemas/ClaimAuditDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimAuditDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Audit Details summary: List ClaimAuditDetail description: Lists all ClaimAuditDetail for the given claimAuditKey operationId: ListClaimAuditDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditKey in: path description: ClaimAudit Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-audits/{claimAuditKey}/details/{claimAuditDetailKey}': get: tags: - Claim Audit Details summary: Get ClaimAuditDetail description: Gets ClaimAuditDetail operationId: GetClaimAuditDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditKey in: path description: ClaimAudit Key required: true schema: type: integer format: int32 - name: claimAuditDetailKey in: path description: ClaimAuditDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Audit Details summary: Update ClaimAuditDetail description: Updates a specific ClaimAuditDetail. operationId: UpdateClaimAuditDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditKey in: path description: ClaimAudit Key required: true schema: type: integer format: int32 - name: claimAuditDetailKey in: path description: ClaimAuditDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAuditDetail' text/json: schema: $ref: '#/components/schemas/ClaimAuditDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimAuditDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Audit Details summary: Delete ClaimAuditDetail description: Deletes an ClaimAuditDetail operationId: DeleteClaimAuditDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditKey in: path description: ClaimAudit Key required: true schema: type: integer format: int32 - name: claimAuditDetailKey in: path description: ClaimAuditDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-audits/{claimAuditKey}/details-batch': put: tags: - Claim Audit Details summary: Create or Update Batch ClaimAuditDetail description: 'Create or Update multiple ClaimAuditDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimAuditDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditKey in: path description: ClaimAudit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-audit-details/{claimAuditDetailKey}/results': post: tags: - Claim Audit Detail Results summary: Create ClaimAuditDetailResult description: Creates a new ClaimAuditDetailResult operationId: CreateClaimAuditDetailResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditDetailKey in: path description: ClaimAuditDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAuditDetailResult' text/json: schema: $ref: '#/components/schemas/ClaimAuditDetailResult' application/*+json: schema: $ref: '#/components/schemas/ClaimAuditDetailResult' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditDetailResultVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditDetailResultVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditDetailResultVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Audit Detail Results summary: List ClaimAuditDetailResult description: Lists all ClaimAuditDetailResult for the given claimAuditDetailKey operationId: ListClaimAuditDetailResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditDetailKey in: path description: ClaimAuditDetail Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditDetailResultListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditDetailResultListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditDetailResultListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-audit-details/{claimAuditDetailKey}/results/{claimAuditDetailResultKey}': get: tags: - Claim Audit Detail Results summary: Get ClaimAuditDetailResult description: Gets ClaimAuditDetailResult operationId: GetClaimAuditDetailResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditDetailKey in: path description: ClaimAuditDetail Key required: true schema: type: integer format: int32 - name: claimAuditDetailResultKey in: path description: ClaimAuditDetailResult Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditDetailResultVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditDetailResultVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditDetailResultVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Audit Detail Results summary: Delete ClaimAuditDetailResult description: Deletes an ClaimAuditDetailResult operationId: DeleteClaimAuditDetailResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditDetailKey in: path description: ClaimAuditDetail Key required: true schema: type: integer format: int32 - name: claimAuditDetailResultKey in: path description: ClaimAuditDetailResult Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-audit-details/{claimAuditDetailKey}/results-batch': put: tags: - Claim Audit Detail Results summary: Create or Update Batch ClaimAuditDetailResult description: 'Create multiple ClaimAuditDetailResult at once. If the entity exists, it will be updated. ' operationId: UpdateBatchClaimAuditDetailResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditDetailKey in: path description: ClaimAuditDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditDetailResult' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditDetailResult' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditDetailResult' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-audit-results: post: tags: - Claim Audit Results summary: Create ClaimAuditResult description: Creates a new ClaimAuditResult operationId: CreateClaimAuditResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAuditResult' text/json: schema: $ref: '#/components/schemas/ClaimAuditResult' application/*+json: schema: $ref: '#/components/schemas/ClaimAuditResult' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditResultVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditResultVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditResultVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Audit Results summary: List ClaimAuditResult description: Lists all ClaimAuditResult operationId: ListClaimAuditResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditResultListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditResultListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditResultListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-audit-results/{auditResult}': get: tags: - Claim Audit Results summary: Get ClaimAuditResult description: Gets ClaimAuditResult operationId: GetClaimAuditResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: auditResult in: path description: Audit Result required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditResultVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditResultVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditResultVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Audit Results summary: Update ClaimAuditResult description: Updates a specific ClaimAuditResult. operationId: UpdateClaimAuditResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: auditResult in: path description: Audit Result required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAuditResult' text/json: schema: $ref: '#/components/schemas/ClaimAuditResult' application/*+json: schema: $ref: '#/components/schemas/ClaimAuditResult' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditResultVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditResultVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditResultVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Audit Results summary: Delete ClaimAuditResult description: Deletes an ClaimAuditResult operationId: DeleteClaimAuditResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: auditResult in: path description: Audit Result required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-audit-results-batch: put: tags: - Claim Audit Results summary: Create or Update Batch ClaimAuditResult description: 'Create or Update multiple ClaimAuditResult at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimAuditResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditResult' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditResult' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditResult' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-audit-statuses: post: tags: - Claim Audit Statuses summary: Create ClaimAuditStatus description: Creates a new ClaimAuditStatus operationId: CreateClaimAuditStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAuditStatus' text/json: schema: $ref: '#/components/schemas/ClaimAuditStatus' application/*+json: schema: $ref: '#/components/schemas/ClaimAuditStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Audit Statuses summary: List ClaimAuditStatus description: Lists all ClaimAuditStatus operationId: ListClaimAuditStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-audit-statuses/{auditStatus}': get: tags: - Claim Audit Statuses summary: Get ClaimAuditStatus description: Gets ClaimAuditStatus operationId: GetClaimAuditStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: auditStatus in: path description: Audit Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Audit Statuses summary: Update ClaimAuditStatus description: Updates a specific ClaimAuditStatus. operationId: UpdateClaimAuditStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: auditStatus in: path description: Audit Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAuditStatus' text/json: schema: $ref: '#/components/schemas/ClaimAuditStatus' application/*+json: schema: $ref: '#/components/schemas/ClaimAuditStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimAuditStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimAuditStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimAuditStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Audit Statuses summary: Delete ClaimAuditStatus description: Deletes an ClaimAuditStatus operationId: DeleteClaimAuditStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: auditStatus in: path description: Audit Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-audit-statuses-batch: put: tags: - Claim Audit Statuses summary: Create or Update Batch ClaimAuditStatus description: 'Create or Update multiple ClaimAuditStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimAuditStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimAuditStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims': post: tags: - Claim Batch summary: Create ClaimBatch description: Creates a new ClaimBatch operationId: CreateClaimBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatch' text/json: schema: $ref: '#/components/schemas/ClaimBatch' application/*+json: schema: $ref: '#/components/schemas/ClaimBatch' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Batch summary: List ClaimBatch description: Lists all ClaimBatch for the given batchNumber operationId: ListClaimBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}': get: tags: - Claim Batch summary: Get ClaimBatch description: Gets ClaimBatch operationId: GetClaimBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Batch summary: Update ClaimBatch description: Updates a specific ClaimBatch. operationId: UpdateClaimBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatch' text/json: schema: $ref: '#/components/schemas/ClaimBatch' application/*+json: schema: $ref: '#/components/schemas/ClaimBatch' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Batch summary: Delete ClaimBatch description: Deletes an ClaimBatch operationId: DeleteClaimBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/full-delete': delete: tags: - Claim Batch - Adv. Claim summary: Full Delete ClaimBatch description: Deletes an ClaimBatch record along with all associated processing needed as a result of that delete. operationId: FullDeleteClaimBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimStatusCategoryCode in: query description: Claim Status Category Code schema: type: string - name: claimStatusCode in: query description: Claim Status Code schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/claim-batches/{batchNumber}/claims-batch': put: tags: - Claim Batch summary: Create or Update Batch ClaimBatch description: 'Create or Update multiple ClaimBatch at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatch' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatch' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimBatch' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/details': post: tags: - Claim Batch Details summary: Create ClaimBatchDetail description: Creates a new ClaimBatchDetail operationId: CreateClaimBatchDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchDetail' text/json: schema: $ref: '#/components/schemas/ClaimBatchDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Batch Details summary: List ClaimBatchDetail description: Lists all ClaimBatchDetail for the given batchNumber and batchClaim operationId: ListClaimBatchDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}': get: tags: - Claim Batch Details summary: Get ClaimBatchDetail description: Gets ClaimBatchDetail operationId: GetClaimBatchDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Batch Details summary: Update ClaimBatchDetail description: Updates a specific ClaimBatchDetail. operationId: UpdateClaimBatchDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchDetail' text/json: schema: $ref: '#/components/schemas/ClaimBatchDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Batch Details summary: Delete ClaimBatchDetail description: Deletes an ClaimBatchDetail operationId: DeleteClaimBatchDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/details-batch': put: tags: - Claim Batch Details summary: Create or Update Batch ClaimBatchDetail description: 'Create or Update multiple ClaimBatchDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimBatchDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/adjudicate-benefit-match': get: tags: - Claim Batch Details - Adv. Claim summary: List matching benefit detail description: List of potential benefit matches along with a match count for a specific claim service line. operationId: ListAdjudicateBenefitMatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: planId in: query description: Plan ID schema: type: string - name: providerId in: query description: Provider ID schema: type: string - name: providerType in: query description: Provider Type schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AdjudicateBenefitMatchDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/AdjudicateBenefitMatchDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/AdjudicateBenefitMatchDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}/benefits': post: tags: - Claim Batch Detail Benefits summary: Create ClaimBatchDetailBenefit description: Creates a new ClaimBatchDetailBenefit operationId: CreateClaimBatchDetailBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefit' text/json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefit' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Batch Detail Benefits summary: List ClaimBatchDetailBenefit description: Lists all ClaimBatchDetailBenefit for the given batchNumber and batchClaim and claimSeq and adjustmentSeq operationId: ListClaimBatchDetailBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefitListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefitListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefitListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}/benefits/{benefitCode}': get: tags: - Claim Batch Detail Benefits summary: Get ClaimBatchDetailBenefit description: Gets ClaimBatchDetailBenefit operationId: GetClaimBatchDetailBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Batch Detail Benefits summary: Update ClaimBatchDetailBenefit description: Updates a specific ClaimBatchDetailBenefit. operationId: UpdateClaimBatchDetailBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefit' text/json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefit' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchDetailBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Batch Detail Benefits summary: Delete ClaimBatchDetailBenefit description: Deletes an ClaimBatchDetailBenefit operationId: DeleteClaimBatchDetailBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}/benefits-batch': put: tags: - Claim Batch Detail Benefits summary: Create or Update Batch ClaimBatchDetailBenefit description: 'Create or Update multiple ClaimBatchDetailBenefit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimBatchDetailBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchDetailBenefit' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchDetailBenefit' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchDetailBenefit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-batches: post: tags: - Claim Batches summary: Create ClaimBatches description: Creates a new ClaimBatches operationId: CreateClaimBatches parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatches' text/json: schema: $ref: '#/components/schemas/ClaimBatches' application/*+json: schema: $ref: '#/components/schemas/ClaimBatches' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchesVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchesVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Batches summary: List ClaimBatches description: Lists all ClaimBatches operationId: ListClaimBatches parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchesListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchesListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}': get: tags: - Claim Batches summary: Get ClaimBatches description: Gets ClaimBatches operationId: GetClaimBatches parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchesVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchesVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Batches summary: Update ClaimBatches description: Updates a specific ClaimBatches. operationId: UpdateClaimBatches parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatches' text/json: schema: $ref: '#/components/schemas/ClaimBatches' application/*+json: schema: $ref: '#/components/schemas/ClaimBatches' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchesVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchesVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Batches summary: Delete ClaimBatches description: Deletes an ClaimBatches operationId: DeleteClaimBatches parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-batches-batch: put: tags: - Claim Batches summary: Create or Update Batch ClaimBatches description: 'Create or Update multiple ClaimBatches at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimBatches parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatches' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatches' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimBatches' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-batches-statuses: post: tags: - Claim Batches Statuses summary: Create ClaimBatchesStatus description: Creates a new ClaimBatchesStatus operationId: CreateClaimBatchesStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchesStatus' text/json: schema: $ref: '#/components/schemas/ClaimBatchesStatus' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchesStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchesStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchesStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchesStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Batches Statuses summary: List ClaimBatchesStatus description: Lists all ClaimBatchesStatus operationId: ListClaimBatchesStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchesStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchesStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchesStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches-statuses/{status}': get: tags: - Claim Batches Statuses summary: Get ClaimBatchesStatus description: Gets ClaimBatchesStatus operationId: GetClaimBatchesStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: status in: path description: Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchesStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchesStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchesStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Batches Statuses summary: Update ClaimBatchesStatus description: Updates a specific ClaimBatchesStatus. operationId: UpdateClaimBatchesStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: status in: path description: Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchesStatus' text/json: schema: $ref: '#/components/schemas/ClaimBatchesStatus' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchesStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchesStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchesStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchesStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Batches Statuses summary: Delete ClaimBatchesStatus description: Deletes an ClaimBatchesStatus operationId: DeleteClaimBatchesStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: status in: path description: Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-batches-statuses-batch: put: tags: - Claim Batches Statuses summary: Create or Update Batch ClaimBatchesStatus description: 'Create or Update multiple ClaimBatchesStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimBatchesStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchesStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchesStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchesStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-lives: post: tags: - Claim Lives summary: Create ClaimBatchLife description: Creates a new ClaimBatchLife operationId: CreateClaimBatchLife parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchLife' text/json: schema: $ref: '#/components/schemas/ClaimBatchLife' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchLife' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchLifeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchLifeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchLifeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Lives summary: List ClaimBatchLife description: Lists all ClaimBatchLife operationId: ListClaimBatchLife parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchLifeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchLifeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchLifeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-lives/{batchNumber}': get: tags: - Claim Lives summary: Get ClaimBatchLife description: Gets ClaimBatchLife operationId: GetClaimBatchLife parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchLifeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchLifeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchLifeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Lives summary: Update ClaimBatchLife description: Updates a specific ClaimBatchLife. operationId: UpdateClaimBatchLife parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchLife' text/json: schema: $ref: '#/components/schemas/ClaimBatchLife' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchLife' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchLifeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchLifeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchLifeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Lives summary: Delete ClaimBatchLife description: Deletes an ClaimBatchLife operationId: DeleteClaimBatchLife parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-lives-batch: put: tags: - Claim Lives summary: Create or Update Batch ClaimBatchLife description: 'Create or Update multiple ClaimBatchLife at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimBatchLife parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchLife' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchLife' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchLife' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/life-benefits': post: tags: - Claim Batch Life Benefits summary: Create ClaimBatchLifeBenefit description: Creates a new ClaimBatchLifeBenefit operationId: CreateClaimBatchLifeBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefit' text/json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefit' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Batch Life Benefits summary: List ClaimBatchLifeBenefit description: Lists all ClaimBatchLifeBenefit for the given batchNumber operationId: ListClaimBatchLifeBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefitListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefitListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefitListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/life-benefits/{benefitCode}': get: tags: - Claim Batch Life Benefits summary: Get ClaimBatchLifeBenefit description: Gets ClaimBatchLifeBenefit operationId: GetClaimBatchLifeBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Batch Life Benefits summary: Update ClaimBatchLifeBenefit description: Updates a specific ClaimBatchLifeBenefit. operationId: UpdateClaimBatchLifeBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefit' text/json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefit' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchLifeBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Batch Life Benefits summary: Delete ClaimBatchLifeBenefit description: Deletes an ClaimBatchLifeBenefit operationId: DeleteClaimBatchLifeBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/life-benefits-batch': put: tags: - Claim Batch Life Benefits summary: Create or Update Batch ClaimBatchLifeBenefit description: 'Create or Update multiple ClaimBatchLifeBenefit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimBatchLifeBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchLifeBenefit' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchLifeBenefit' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchLifeBenefit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-batch-logs: post: tags: - Claim Batch Logs summary: Create ClaimBatchLog description: Creates a new ClaimBatchLog operationId: CreateClaimBatchLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchLog' text/json: schema: $ref: '#/components/schemas/ClaimBatchLog' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchLog' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchLogVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchLogVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Batch Logs summary: List ClaimBatchLog description: Lists all ClaimBatchLog operationId: ListClaimBatchLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchLogListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchLogListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchLogListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batch-logs/{claimBatchLogKey}': get: tags: - Claim Batch Logs summary: Get ClaimBatchLog description: Gets ClaimBatchLog operationId: GetClaimBatchLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimBatchLogKey in: path description: ClaimBatchLog Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchLogVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchLogVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Batch Logs summary: Update ClaimBatchLog description: Updates a specific ClaimBatchLog. operationId: UpdateClaimBatchLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimBatchLogKey in: path description: ClaimBatchLog Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchLog' text/json: schema: $ref: '#/components/schemas/ClaimBatchLog' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchLog' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchLogVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchLogVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Batch Logs summary: Delete ClaimBatchLog description: Deletes an ClaimBatchLog operationId: DeleteClaimBatchLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimBatchLogKey in: path description: ClaimBatchLog Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-batch-logs-batch: put: tags: - Claim Batch Logs summary: Create or Update Batch ClaimBatchLog description: 'Create or Update multiple ClaimBatchLog at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimBatchLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchLog' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchLog' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchLog' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/plans': post: tags: - Claim Batch Plans summary: Create ClaimBatchPlan description: Creates a new ClaimBatchPlan operationId: CreateClaimBatchPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchPlan' text/json: schema: $ref: '#/components/schemas/ClaimBatchPlan' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchPlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Batch Plans summary: List ClaimBatchPlan description: Lists all ClaimBatchPlan for the given batchNumber and batchClaim operationId: ListClaimBatchPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchPlanListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchPlanListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchPlanListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/plans/{planID}': get: tags: - Claim Batch Plans summary: Get ClaimBatchPlan description: Gets ClaimBatchPlan operationId: GetClaimBatchPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Batch Plans summary: Update ClaimBatchPlan description: Updates a specific ClaimBatchPlan. operationId: UpdateClaimBatchPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchPlan' text/json: schema: $ref: '#/components/schemas/ClaimBatchPlan' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchPlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Batch Plans summary: Delete ClaimBatchPlan description: Deletes an ClaimBatchPlan operationId: DeleteClaimBatchPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/plans-batch': put: tags: - Claim Batch Plans summary: Create or Update Batch ClaimBatchPlan description: 'Create or Update multiple ClaimBatchPlan at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimBatchPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchPlan' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchPlan' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchPlan' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-batch-references: post: tags: - Claim Batch References summary: Create ClaimBatchReference description: Creates a new ClaimBatchReference operationId: CreateClaimBatchReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchReference' text/json: schema: $ref: '#/components/schemas/ClaimBatchReference' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchReference' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchReferenceVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchReferenceVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchReferenceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Batch References summary: List ClaimBatchReference description: Lists all ClaimBatchReference operationId: ListClaimBatchReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchReferenceListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchReferenceListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchReferenceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batch-references/{originalBatchNumber}/{originalBatchClaim}/{referencedBatchNumber}/{referencedBatchClaim}/{referenceType}': get: tags: - Claim Batch References summary: Get ClaimBatchReference description: Gets ClaimBatchReference operationId: GetClaimBatchReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: originalBatchNumber in: path description: Original Batch Number required: true schema: type: integer format: int32 - name: originalBatchClaim in: path description: Original Batch Claim required: true schema: type: integer format: int32 - name: referencedBatchNumber in: path description: Referenced Batch Number required: true schema: type: integer format: int32 - name: referencedBatchClaim in: path description: Referenced Batch Claim required: true schema: type: integer format: int32 - name: referenceType in: path description: Reference Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchReferenceVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchReferenceVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchReferenceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Batch References summary: Update ClaimBatchReference description: Updates a specific ClaimBatchReference. operationId: UpdateClaimBatchReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: originalBatchNumber in: path description: Original Batch Number required: true schema: type: integer format: int32 - name: originalBatchClaim in: path description: Original Batch Claim required: true schema: type: integer format: int32 - name: referencedBatchNumber in: path description: Referenced Batch Number required: true schema: type: integer format: int32 - name: referencedBatchClaim in: path description: Referenced Batch Claim required: true schema: type: integer format: int32 - name: referenceType in: path description: Reference Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchReference' text/json: schema: $ref: '#/components/schemas/ClaimBatchReference' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchReference' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchReferenceVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchReferenceVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchReferenceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Batch References summary: Delete ClaimBatchReference description: Deletes an ClaimBatchReference operationId: DeleteClaimBatchReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: originalBatchNumber in: path description: Original Batch Number required: true schema: type: integer format: int32 - name: originalBatchClaim in: path description: Original Batch Claim required: true schema: type: integer format: int32 - name: referencedBatchNumber in: path description: Referenced Batch Number required: true schema: type: integer format: int32 - name: referencedBatchClaim in: path description: Referenced Batch Claim required: true schema: type: integer format: int32 - name: referenceType in: path description: Reference Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-batch-references-batch: put: tags: - Claim Batch References summary: Create or Update Batch ClaimBatchReference description: 'Create or Update multiple ClaimBatchReference at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimBatchReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchReference' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchReference' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchReference' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-batch-types: post: tags: - Claim Batch Types summary: Create ClaimBatchType description: Creates a new ClaimBatchType operationId: CreateClaimBatchType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchType' text/json: schema: $ref: '#/components/schemas/ClaimBatchType' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Batch Types summary: List ClaimBatchType description: Lists all ClaimBatchType operationId: ListClaimBatchType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batch-types/{batchType}': get: tags: - Claim Batch Types summary: Get ClaimBatchType description: Gets ClaimBatchType operationId: GetClaimBatchType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchType in: path description: Batch Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Batch Types summary: Update ClaimBatchType description: Updates a specific ClaimBatchType. operationId: UpdateClaimBatchType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchType in: path description: Batch Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimBatchType' text/json: schema: $ref: '#/components/schemas/ClaimBatchType' application/*+json: schema: $ref: '#/components/schemas/ClaimBatchType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatchTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatchTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatchTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Batch Types summary: Delete ClaimBatchType description: Deletes an ClaimBatchType operationId: DeleteClaimBatchType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchType in: path description: Batch Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-batch-types-batch: put: tags: - Claim Batch Types summary: Create or Update Batch ClaimBatchType description: 'Create or Update multiple ClaimBatchType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimBatchType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchType' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchType' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-coding-rules: post: tags: - Claim Coding Rules summary: Create ClaimCodingRule description: Creates a new ClaimCodingRule operationId: CreateClaimCodingRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimCodingRule' text/json: schema: $ref: '#/components/schemas/ClaimCodingRule' application/*+json: schema: $ref: '#/components/schemas/ClaimCodingRule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimCodingRuleVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimCodingRuleVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimCodingRuleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Coding Rules summary: List ClaimCodingRule description: Lists all ClaimCodingRule operationId: ListClaimCodingRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimCodingRuleListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimCodingRuleListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimCodingRuleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-coding-rules/{claimCodingRuleKey}': get: tags: - Claim Coding Rules summary: Get ClaimCodingRule description: Gets ClaimCodingRule operationId: GetClaimCodingRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimCodingRuleKey in: path description: ClaimCodingRule Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimCodingRuleVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimCodingRuleVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimCodingRuleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Coding Rules summary: Update ClaimCodingRule description: Updates a specific ClaimCodingRule. operationId: UpdateClaimCodingRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimCodingRuleKey in: path description: ClaimCodingRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimCodingRule' text/json: schema: $ref: '#/components/schemas/ClaimCodingRule' application/*+json: schema: $ref: '#/components/schemas/ClaimCodingRule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimCodingRuleVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimCodingRuleVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimCodingRuleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Coding Rules summary: Delete ClaimCodingRule description: Deletes an ClaimCodingRule operationId: DeleteClaimCodingRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimCodingRuleKey in: path description: ClaimCodingRule Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-coding-rules-batch: put: tags: - Claim Coding Rules summary: Create or Update Batch ClaimCodingRule description: 'Create or Update multiple ClaimCodingRule at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimCodingRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimCodingRule' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimCodingRule' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimCodingRule' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-coding-rule-types: post: tags: - Claim Coding Rule Types summary: Create ClaimCodingRuleType description: Creates a new ClaimCodingRuleType operationId: CreateClaimCodingRuleType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimCodingRuleType' text/json: schema: $ref: '#/components/schemas/ClaimCodingRuleType' application/*+json: schema: $ref: '#/components/schemas/ClaimCodingRuleType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimCodingRuleTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimCodingRuleTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimCodingRuleTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Coding Rule Types summary: List ClaimCodingRuleType description: Lists all ClaimCodingRuleType operationId: ListClaimCodingRuleType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimCodingRuleTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimCodingRuleTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimCodingRuleTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-coding-rule-types/{ruleType}': get: tags: - Claim Coding Rule Types summary: Get ClaimCodingRuleType description: Gets ClaimCodingRuleType operationId: GetClaimCodingRuleType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ruleType in: path description: Rule Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimCodingRuleTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimCodingRuleTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimCodingRuleTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Coding Rule Types summary: Update ClaimCodingRuleType description: Updates a specific ClaimCodingRuleType. operationId: UpdateClaimCodingRuleType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ruleType in: path description: Rule Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimCodingRuleType' text/json: schema: $ref: '#/components/schemas/ClaimCodingRuleType' application/*+json: schema: $ref: '#/components/schemas/ClaimCodingRuleType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimCodingRuleTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimCodingRuleTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimCodingRuleTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Coding Rule Types summary: Delete ClaimCodingRuleType description: Deletes an ClaimCodingRuleType operationId: DeleteClaimCodingRuleType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ruleType in: path description: Rule Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-coding-rule-types-batch: put: tags: - Claim Coding Rule Types summary: Create or Update Batch ClaimCodingRuleType description: 'Create or Update multiple ClaimCodingRuleType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimCodingRuleType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimCodingRuleType' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimCodingRuleType' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimCodingRuleType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-condition-codes: post: tags: - Claim Condition Codes summary: Create ClaimConditionCode description: Creates a new ClaimConditionCode operationId: CreateClaimConditionCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimConditionCode' text/json: schema: $ref: '#/components/schemas/ClaimConditionCode' application/*+json: schema: $ref: '#/components/schemas/ClaimConditionCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimConditionCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimConditionCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimConditionCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Condition Codes summary: List ClaimConditionCode description: Lists all ClaimConditionCode operationId: ListClaimConditionCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimConditionCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimConditionCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimConditionCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-condition-codes/{conditionCode}': get: tags: - Claim Condition Codes summary: Get ClaimConditionCode description: Gets ClaimConditionCode operationId: GetClaimConditionCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: conditionCode in: path description: Condition Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimConditionCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimConditionCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimConditionCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Condition Codes summary: Update ClaimConditionCode description: Updates a specific ClaimConditionCode. operationId: UpdateClaimConditionCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: conditionCode in: path description: Condition Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimConditionCode' text/json: schema: $ref: '#/components/schemas/ClaimConditionCode' application/*+json: schema: $ref: '#/components/schemas/ClaimConditionCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimConditionCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimConditionCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimConditionCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Condition Codes summary: Delete ClaimConditionCode description: Deletes an ClaimConditionCode operationId: DeleteClaimConditionCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: conditionCode in: path description: Condition Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-condition-codes-batch: put: tags: - Claim Condition Codes summary: Create or Update Batch ClaimConditionCode description: 'Create or Update multiple ClaimConditionCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimConditionCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimConditionCode' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimConditionCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimConditionCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-custom-ex-code-rules: post: tags: - Claim Custom Ex Code Rules summary: Create ClaimCustomExCodeRule description: Creates a new ClaimCustomExCodeRule operationId: CreateClaimCustomExCodeRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRule' text/json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRule' application/*+json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimCustomExCodeRuleVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRuleVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRuleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Custom Ex Code Rules summary: List ClaimCustomExCodeRule description: Lists all ClaimCustomExCodeRule operationId: ListClaimCustomExCodeRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimCustomExCodeRuleListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRuleListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRuleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-custom-ex-code-rules/{customExCodeRuleKey}': get: tags: - Claim Custom Ex Code Rules summary: Get ClaimCustomExCodeRule description: Gets ClaimCustomExCodeRule operationId: GetClaimCustomExCodeRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: customExCodeRuleKey in: path description: ClaimCustomExCodeRule Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimCustomExCodeRuleVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRuleVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRuleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Custom Ex Code Rules summary: Update ClaimCustomExCodeRule description: Updates a specific ClaimCustomExCodeRule. operationId: UpdateClaimCustomExCodeRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: customExCodeRuleKey in: path description: ClaimCustomExCodeRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRule' text/json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRule' application/*+json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimCustomExCodeRuleVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRuleVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimCustomExCodeRuleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Custom Ex Code Rules summary: Delete ClaimCustomExCodeRule description: Deletes an ClaimCustomExCodeRule operationId: DeleteClaimCustomExCodeRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: customExCodeRuleKey in: path description: ClaimCustomExCodeRule Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-custom-ex-code-rules-batch: put: tags: - Claim Custom Ex Code Rules summary: Create or Update Batch ClaimCustomExCodeRule description: 'Create or Update multiple ClaimCustomExCodeRule at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimCustomExCodeRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimCustomExCodeRule' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimCustomExCodeRule' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimCustomExCodeRule' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-deduction-types: post: tags: - Claim Deduction Types summary: Create ClaimDeductionType description: Creates a new ClaimDeductionType operationId: CreateClaimDeductionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimDeductionType' text/json: schema: $ref: '#/components/schemas/ClaimDeductionType' application/*+json: schema: $ref: '#/components/schemas/ClaimDeductionType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDeductionTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDeductionTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDeductionTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Deduction Types summary: List ClaimDeductionType description: Lists all ClaimDeductionType operationId: ListClaimDeductionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDeductionTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDeductionTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDeductionTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-deduction-types/{deductionType}': get: tags: - Claim Deduction Types summary: Get ClaimDeductionType description: Gets ClaimDeductionType operationId: GetClaimDeductionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: deductionType in: path description: Deduction Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDeductionTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDeductionTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDeductionTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Deduction Types summary: Update ClaimDeductionType description: Updates a specific ClaimDeductionType. operationId: UpdateClaimDeductionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: deductionType in: path description: Deduction Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimDeductionType' text/json: schema: $ref: '#/components/schemas/ClaimDeductionType' application/*+json: schema: $ref: '#/components/schemas/ClaimDeductionType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDeductionTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDeductionTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDeductionTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Deduction Types summary: Delete ClaimDeductionType description: Deletes an ClaimDeductionType operationId: DeleteClaimDeductionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: deductionType in: path description: Deduction Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-deduction-types-batch: put: tags: - Claim Deduction Types summary: Create or Update Batch ClaimDeductionType description: 'Create or Update multiple ClaimDeductionType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimDeductionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimDeductionType' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimDeductionType' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimDeductionType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claims/{claimNumber}/details': post: tags: - Claim Details summary: Create ClaimDetail description: Creates a new ClaimDetail operationId: CreateClaimDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimDetail' text/json: schema: $ref: '#/components/schemas/ClaimDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Details summary: List ClaimDetail description: Lists all ClaimDetail for the given claimNumber operationId: ListClaimDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claims/{claimNumber}/details/{claimSeq}/{adjustmentSeq}': get: tags: - Claim Details summary: Get ClaimDetail description: Gets ClaimDetail operationId: GetClaimDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Details summary: Update ClaimDetail description: Updates a specific ClaimDetail. operationId: UpdateClaimDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimDetail' text/json: schema: $ref: '#/components/schemas/ClaimDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Details summary: Delete ClaimDetail description: Deletes an ClaimDetail operationId: DeleteClaimDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claims/{claimNumber}/details-batch': put: tags: - Claim Details summary: Create or Update Batch ClaimDetail description: 'Create or Update multiple ClaimDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}/deductions': post: tags: - Claim Detail Deductions summary: Create ClaimDetailDeduction description: Creates a new ClaimDetailDeduction operationId: CreateClaimDetailDeduction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimDetailDeduction' text/json: schema: $ref: '#/components/schemas/ClaimDetailDeduction' application/*+json: schema: $ref: '#/components/schemas/ClaimDetailDeduction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDetailDeductionVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDetailDeductionVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDetailDeductionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Detail Deductions summary: List ClaimDetailDeduction description: Lists all ClaimDetailDeduction for the given batchNumber and batchClaim and claimSeq and adjustmentSeq operationId: ListClaimDetailDeduction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDetailDeductionListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDetailDeductionListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDetailDeductionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}/deductions/{deductionSeq}': get: tags: - Claim Detail Deductions summary: Get ClaimDetailDeduction description: Gets ClaimDetailDeduction operationId: GetClaimDetailDeduction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string - name: deductionSeq in: path description: Deduction Seq required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDetailDeductionVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDetailDeductionVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDetailDeductionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Detail Deductions summary: Update ClaimDetailDeduction description: Updates a specific ClaimDetailDeduction. operationId: UpdateClaimDetailDeduction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string - name: deductionSeq in: path description: Deduction Seq required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimDetailDeduction' text/json: schema: $ref: '#/components/schemas/ClaimDetailDeduction' application/*+json: schema: $ref: '#/components/schemas/ClaimDetailDeduction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDetailDeductionVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDetailDeductionVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDetailDeductionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Detail Deductions summary: Delete ClaimDetailDeduction description: Deletes an ClaimDetailDeduction operationId: DeleteClaimDetailDeduction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string - name: deductionSeq in: path description: Deduction Seq required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}/deductions-batch': put: tags: - Claim Detail Deductions summary: Create or Update Batch ClaimDetailDeduction description: 'Create or Update multiple ClaimDetailDeduction at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimDetailDeduction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimDetailDeduction' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimDetailDeduction' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimDetailDeduction' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}/ex-codes': post: tags: - Claim Detail Ex Codes summary: Create ClaimDetailExCode description: Creates a new ClaimDetailExCode operationId: CreateClaimDetailExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimDetailExCode' text/json: schema: $ref: '#/components/schemas/ClaimDetailExCode' application/*+json: schema: $ref: '#/components/schemas/ClaimDetailExCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDetailExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDetailExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDetailExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Detail Ex Codes summary: List ClaimDetailExCode description: Lists all ClaimDetailExCode for the given batchNumber and batchClaim and claimSeq and adjustmentSeq operationId: ListClaimDetailExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDetailExCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDetailExCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDetailExCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}/ex-codes/{exCode}': get: tags: - Claim Detail Ex Codes summary: Get ClaimDetailExCode description: Gets ClaimDetailExCode operationId: GetClaimDetailExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string - name: exCode in: path description: Ex Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDetailExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDetailExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDetailExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Detail Ex Codes summary: Update ClaimDetailExCode description: Updates a specific ClaimDetailExCode. operationId: UpdateClaimDetailExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string - name: exCode in: path description: Ex Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimDetailExCode' text/json: schema: $ref: '#/components/schemas/ClaimDetailExCode' application/*+json: schema: $ref: '#/components/schemas/ClaimDetailExCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDetailExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDetailExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDetailExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Detail Ex Codes summary: Delete ClaimDetailExCode description: Deletes an ClaimDetailExCode operationId: DeleteClaimDetailExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string - name: exCode in: path description: Ex Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}/ex-codes-batch': put: tags: - Claim Detail Ex Codes summary: Create or Update Batch ClaimDetailExCode description: 'Create or Update multiple ClaimDetailExCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimDetailExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimDetailExCode' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimDetailExCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimDetailExCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-disabilities: post: tags: - Claim Disabilities summary: Create ClaimDisability description: Creates a new ClaimDisability operationId: CreateClaimDisability parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimDisability' text/json: schema: $ref: '#/components/schemas/ClaimDisability' application/*+json: schema: $ref: '#/components/schemas/ClaimDisability' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDisabilityVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDisabilityVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDisabilityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Disabilities summary: List ClaimDisability description: Lists all ClaimDisability operationId: ListClaimDisability parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDisabilityListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDisabilityListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDisabilityListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-disabilities/{batchNumber}': get: tags: - Claim Disabilities summary: Get ClaimDisability description: Gets ClaimDisability operationId: GetClaimDisability parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDisabilityVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDisabilityVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDisabilityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Disabilities summary: Update ClaimDisability description: Updates a specific ClaimDisability. operationId: UpdateClaimDisability parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimDisability' text/json: schema: $ref: '#/components/schemas/ClaimDisability' application/*+json: schema: $ref: '#/components/schemas/ClaimDisability' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDisabilityVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDisabilityVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDisabilityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Disabilities summary: Delete ClaimDisability description: Deletes an ClaimDisability operationId: DeleteClaimDisability parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-disabilities-batch: put: tags: - Claim Disabilities summary: Create or Update Batch ClaimDisability description: 'Create or Update multiple ClaimDisability at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimDisability parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimDisability' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimDisability' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimDisability' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-disability-deductions: post: tags: - Claim Disability Deductions summary: Create ClaimDisabilityDeduction description: Creates a new ClaimDisabilityDeduction operationId: CreateClaimDisabilityDeduction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimDisabilityDeduction' text/json: schema: $ref: '#/components/schemas/ClaimDisabilityDeduction' application/*+json: schema: $ref: '#/components/schemas/ClaimDisabilityDeduction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDisabilityDeductionVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDisabilityDeductionVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDisabilityDeductionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Disability Deductions summary: List ClaimDisabilityDeduction description: Lists all ClaimDisabilityDeduction operationId: ListClaimDisabilityDeduction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDisabilityDeductionListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDisabilityDeductionListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDisabilityDeductionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-disability-deductions/{batchNumber}': get: tags: - Claim Disability Deductions summary: Get ClaimDisabilityDeduction description: Gets ClaimDisabilityDeduction operationId: GetClaimDisabilityDeduction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDisabilityDeductionVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDisabilityDeductionVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDisabilityDeductionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Disability Deductions summary: Update ClaimDisabilityDeduction description: Updates a specific ClaimDisabilityDeduction. operationId: UpdateClaimDisabilityDeduction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimDisabilityDeduction' text/json: schema: $ref: '#/components/schemas/ClaimDisabilityDeduction' application/*+json: schema: $ref: '#/components/schemas/ClaimDisabilityDeduction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimDisabilityDeductionVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimDisabilityDeductionVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimDisabilityDeductionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Disability Deductions summary: Delete ClaimDisabilityDeduction description: Deletes an ClaimDisabilityDeduction operationId: DeleteClaimDisabilityDeduction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-disability-deductions-batch: put: tags: - Claim Disability Deductions summary: Create or Update Batch ClaimDisabilityDeduction description: 'Create or Update multiple ClaimDisabilityDeduction at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimDisabilityDeduction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimDisabilityDeduction' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimDisabilityDeduction' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimDisabilityDeduction' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/ex-codes': post: tags: - Claim Ex Codes summary: Create ClaimExCode description: Creates a new ClaimExCode operationId: CreateClaimExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimExCode' text/json: schema: $ref: '#/components/schemas/ClaimExCode' application/*+json: schema: $ref: '#/components/schemas/ClaimExCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Ex Codes summary: List ClaimExCode description: Lists all ClaimExCode for the given batchNumber and batchClaim operationId: ListClaimExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimExCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimExCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimExCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/ex-codes/{exCode}': get: tags: - Claim Ex Codes summary: Get ClaimExCode description: Gets ClaimExCode operationId: GetClaimExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: exCode in: path description: Ex Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Ex Codes summary: Update ClaimExCode description: Updates a specific ClaimExCode. operationId: UpdateClaimExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: exCode in: path description: Ex Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimExCode' text/json: schema: $ref: '#/components/schemas/ClaimExCode' application/*+json: schema: $ref: '#/components/schemas/ClaimExCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Ex Codes summary: Delete ClaimExCode description: Deletes an ClaimExCode operationId: DeleteClaimExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: exCode in: path description: Ex Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/ex-codes-batch': put: tags: - Claim Ex Codes summary: Create or Update Batch ClaimExCode description: 'Create or Update multiple ClaimExCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimExCode' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimExCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimExCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /flex-claims: post: tags: - Flex Claims summary: Create ClaimFlex description: Creates a new ClaimFlex operationId: CreateClaimFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimFlex' text/json: schema: $ref: '#/components/schemas/ClaimFlex' application/*+json: schema: $ref: '#/components/schemas/ClaimFlex' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFlexVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFlexVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFlexVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Flex Claims summary: List ClaimFlex description: Lists all ClaimFlex operationId: ListClaimFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFlexListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFlexListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFlexListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-claims/{claimFlexKey}': get: tags: - Flex Claims summary: Get ClaimFlex description: Gets ClaimFlex operationId: GetClaimFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFlexVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFlexVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFlexVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Flex Claims summary: Update ClaimFlex description: Updates a specific ClaimFlex. operationId: UpdateClaimFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimFlex' text/json: schema: $ref: '#/components/schemas/ClaimFlex' application/*+json: schema: $ref: '#/components/schemas/ClaimFlex' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFlexVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFlexVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFlexVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Flex Claims summary: Delete ClaimFlex description: Deletes an ClaimFlex operationId: DeleteClaimFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /flex-claims-batch: put: tags: - Flex Claims summary: Create or Update Batch ClaimFlex description: 'Create or Update multiple ClaimFlex at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimFlex' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimFlex' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimFlex' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-claims/{claimFlexKey}/details': post: tags: - Flex Claim Details summary: Create ClaimFlexDetail description: Creates a new ClaimFlexDetail operationId: CreateClaimFlexDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimFlexDetail' text/json: schema: $ref: '#/components/schemas/ClaimFlexDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimFlexDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFlexDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFlexDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFlexDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Flex Claim Details summary: List ClaimFlexDetail description: Lists all ClaimFlexDetail for the given claimFlexKey operationId: ListClaimFlexDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFlexDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFlexDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFlexDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-claims/{claimFlexKey}/details/{batchNumber}/{batchClaim}': get: tags: - Flex Claim Details summary: Get ClaimFlexDetail description: Gets ClaimFlexDetail operationId: GetClaimFlexDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFlexDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFlexDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFlexDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Flex Claim Details summary: Update ClaimFlexDetail description: Updates a specific ClaimFlexDetail. operationId: UpdateClaimFlexDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimFlexDetail' text/json: schema: $ref: '#/components/schemas/ClaimFlexDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimFlexDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFlexDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFlexDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFlexDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Flex Claim Details summary: Delete ClaimFlexDetail description: Deletes an ClaimFlexDetail operationId: DeleteClaimFlexDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-claims/{claimFlexKey}/details-batch': put: tags: - Flex Claim Details summary: Create or Update Batch ClaimFlexDetail description: 'Create or Update multiple ClaimFlexDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimFlexDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimFlexDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimFlexDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimFlexDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-claims/{claimFlexKey}/services': post: tags: - Flex Claim Services summary: Create ClaimFlexService description: Creates a new ClaimFlexService operationId: CreateClaimFlexService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimFlexService' text/json: schema: $ref: '#/components/schemas/ClaimFlexService' application/*+json: schema: $ref: '#/components/schemas/ClaimFlexService' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFlexServiceVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFlexServiceVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFlexServiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Flex Claim Services summary: List ClaimFlexService description: Lists all ClaimFlexService for the given claimFlexKey operationId: ListClaimFlexService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFlexServiceListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFlexServiceListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFlexServiceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-claims/{claimFlexKey}/services/{claimFlexServiceKey}': get: tags: - Flex Claim Services summary: Get ClaimFlexService description: Gets ClaimFlexService operationId: GetClaimFlexService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 - name: claimFlexServiceKey in: path description: ClaimFlexService Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFlexServiceVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFlexServiceVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFlexServiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Flex Claim Services summary: Update ClaimFlexService description: Updates a specific ClaimFlexService. operationId: UpdateClaimFlexService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 - name: claimFlexServiceKey in: path description: ClaimFlexService Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimFlexService' text/json: schema: $ref: '#/components/schemas/ClaimFlexService' application/*+json: schema: $ref: '#/components/schemas/ClaimFlexService' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFlexServiceVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFlexServiceVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFlexServiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Flex Claim Services summary: Delete ClaimFlexService description: Deletes an ClaimFlexService operationId: DeleteClaimFlexService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 - name: claimFlexServiceKey in: path description: ClaimFlexService Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-claims/{claimFlexKey}/services-batch': put: tags: - Flex Claim Services summary: Create or Update Batch ClaimFlexService description: 'Create or Update multiple ClaimFlexService at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimFlexService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFlexKey in: path description: ClaimFlex Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimFlexService' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimFlexService' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimFlexService' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-funded-statuses: post: tags: - Claim Funded Statuses summary: Create ClaimFundedStatus description: Creates a new ClaimFundedStatus operationId: CreateClaimFundedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimFundedStatus' text/json: schema: $ref: '#/components/schemas/ClaimFundedStatus' application/*+json: schema: $ref: '#/components/schemas/ClaimFundedStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFundedStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFundedStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFundedStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Funded Statuses summary: List ClaimFundedStatus description: Lists all ClaimFundedStatus operationId: ListClaimFundedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFundedStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFundedStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFundedStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-funded-statuses/{claimFundedStatus}': get: tags: - Claim Funded Statuses summary: Get ClaimFundedStatus description: Gets ClaimFundedStatus operationId: GetClaimFundedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFundedStatus in: path description: Claim Funded Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFundedStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFundedStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFundedStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Funded Statuses summary: Update ClaimFundedStatus description: Updates a specific ClaimFundedStatus. operationId: UpdateClaimFundedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFundedStatus in: path description: Claim Funded Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimFundedStatus' text/json: schema: $ref: '#/components/schemas/ClaimFundedStatus' application/*+json: schema: $ref: '#/components/schemas/ClaimFundedStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimFundedStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimFundedStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimFundedStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Funded Statuses summary: Delete ClaimFundedStatus description: Deletes an ClaimFundedStatus operationId: DeleteClaimFundedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimFundedStatus in: path description: Claim Funded Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-funded-statuses-batch: put: tags: - Claim Funded Statuses summary: Create or Update Batch ClaimFundedStatus description: 'Create or Update multiple ClaimFundedStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimFundedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimFundedStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimFundedStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimFundedStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /create-life-claim: post: tags: - Adv. Claim summary: Create a Life Claim description: Setup a Life Claim based on defined configuration and optionally setup the Life Claim payments. operationId: CreateLifeClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LifeClaimAdvisor' text/json: schema: $ref: '#/components/schemas/LifeClaimAdvisor' application/*+json: schema: $ref: '#/components/schemas/LifeClaimAdvisor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32VBAResponse' application/json: schema: $ref: '#/components/schemas/Int32VBAResponse' text/json: schema: $ref: '#/components/schemas/Int32VBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /suspense-claim-release: post: tags: - Adv. Claim summary: Release Suspended Claims description: Release a selection of suspended claims so they can be Funded. operationId: SuspenseClaimRelease parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SuspenseClaimList' text/json: schema: type: array items: $ref: '#/components/schemas/SuspenseClaimList' application/*+json: schema: type: array items: $ref: '#/components/schemas/SuspenseClaimList' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/suspense-claim-return/{exCode}': post: tags: - Adv. Claim summary: Return Suspended Claims description: Return a selection of suspended claims to Batch so they can be reprocessed. Assign an optional Ex Code to the claim returned. operationId: SuspenseClaimReturn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: exCode in: path description: Ex Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SuspenseClaimList' text/json: schema: type: array items: $ref: '#/components/schemas/SuspenseClaimList' application/*+json: schema: type: array items: $ref: '#/components/schemas/SuspenseClaimList' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /claim-adjustment: post: tags: - Adv. Claim summary: Adjust Claim(s) description: Adjust a selected list of claims by Claim Number. operationId: AdjustClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimAdjustmentConfig' text/json: schema: $ref: '#/components/schemas/ClaimAdjustmentConfig' application/*+json: schema: $ref: '#/components/schemas/ClaimAdjustmentConfig' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /claim-return-to-batch: post: tags: - Adv. Claim summary: Return Claim(s) to Batch description: Return a selected list of claims to batch. operationId: ReturnClaimToBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: type: integer format: int32 text/json: schema: type: array items: type: integer format: int32 application/*+json: schema: type: array items: type: integer format: int32 required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /claim-copy-to-batch: post: tags: - Adv. Claim summary: Copy Claim(s) to Batch description: Copy a selected list of claims to batch. operationId: CopyClaimToBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: type: integer format: int32 text/json: schema: type: array items: type: integer format: int32 application/*+json: schema: type: array items: type: integer format: int32 required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /claim-copy-multi-payor-account: post: tags: - Adv. Claim summary: Split Claims by Payor/Account description: 'When the chosen claim has a multi-Payor/Account error, this process will automatically split the claim and create a bridgre reference in ClaimBatchReference.' operationId: CopyClaimMultiPayorAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: query description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: query description: Batch Claim required: true schema: type: integer format: int32 responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /claim-copy-multi-plan-year: post: tags: - Adv. Claim summary: Split Claims by Plan Year description: 'When the chosen claim has a multi-Plan Year error, this process will automatically split the claim and create a bridgre reference in ClaimBatchReference.' operationId: CopyClaimMultiPlanYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: query description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: query description: Batch Claim required: true schema: type: integer format: int32 responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /claim-suspend-from-audit: post: tags: - Adv. Claim summary: Suspend Claims on Audit description: This process will take a Claim Audit key and then suspend any claims associated with that Claim Audit (assuming that claim is not Funded). operationId: SuspendFromAudit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimAuditKey in: query description: Claim Audit Key required: true schema: type: integer format: int32 responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /claim-copy-service-lines: post: tags: - Adv. Claim summary: Copy Selected Service Lines description: Copy a list of ClaimBatchDetails x amount of times and add y amount of days to each copy. operationId: CopyClaimServiceLine parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: numberOfCopies in: query description: Number of Copies required: true schema: type: integer format: int32 - name: daysOnCopy in: query description: Days on Copy required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimBatchDetail' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /disability-advisor-create-claim: post: tags: - Adv. Claim summary: Create Disability Payments description: Create a Batch of Claims that represent Disability Payments for a STD or LTD disability claim. operationId: DisabilityAdvisorCreateClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBA_DisabilityAdvisor' text/json: schema: $ref: '#/components/schemas/VBA_DisabilityAdvisor' application/*+json: schema: $ref: '#/components/schemas/VBA_DisabilityAdvisor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /disability-claim-sync-header: post: tags: - Adv. Claim summary: Sync ClaimBatch Disability description: Send in a ClaimBatch record and have all other ClaimBatch records remaining in Batch syncd to the Disability values on that submitted header. operationId: DisabilityClaimSync parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: query description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: query description: Batch Claim required: true schema: type: integer format: int32 responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /claim-invoice-statuses: get: tags: - Events summary: List of Claim Invoice Statuses description: List of Claim Invoice Statuses operationId: ListClaimInvoiceStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-invoice-generate: post: tags: - Adv. Claim summary: Generate Claim Invoice description: Creates a Claim Invoice and attaches a list of Claims. operationId: GenerateClaimInvoice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoiceConfig' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceConfig' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoiceConfig' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimBatch_ClaimBatchDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimBatch_ClaimBatchDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimBatch_ClaimBatchDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /claim-invoice: post: tags: - Claim Invoice summary: Create ClaimInvoice description: Creates a new ClaimInvoice operationId: CreateClaimInvoice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoice' text/json: schema: $ref: '#/components/schemas/ClaimInvoice' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Invoice summary: List ClaimInvoice description: Lists all ClaimInvoice operationId: ListClaimInvoice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice/{invoiceKey}': get: tags: - Claim Invoice summary: Get ClaimInvoice description: Gets ClaimInvoice operationId: GetClaimInvoice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Invoice summary: Update ClaimInvoice description: Updates a specific ClaimInvoice. operationId: UpdateClaimInvoice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoice' text/json: schema: $ref: '#/components/schemas/ClaimInvoice' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Invoice summary: Delete ClaimInvoice description: Deletes an ClaimInvoice operationId: DeleteClaimInvoice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-invoice-batch: put: tags: - Claim Invoice summary: Create or Update Batch ClaimInvoice description: 'Create or Update multiple ClaimInvoice at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimInvoice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoice' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoice' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoice' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-invoice-adjustments: post: tags: - Claim Invoice Adjustments summary: Create ClaimInvoiceAdjustment description: Creates a new ClaimInvoiceAdjustment operationId: CreateClaimInvoiceAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustment' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustment' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice/{invoiceKey}/adjustments': get: tags: - Claim Invoice Adjustments summary: List ClaimInvoiceAdjustment description: Lists all ClaimInvoiceAdjustment for the given invoiceKey operationId: ListClaimInvoiceAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice-adjustments/{claimInvoiceAdjustmentKey}': get: tags: - Claim Invoice Adjustments summary: Get ClaimInvoiceAdjustment description: Gets ClaimInvoiceAdjustment operationId: GetClaimInvoiceAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimInvoiceAdjustmentKey in: path description: ClaimInvoiceAdjustment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Invoice Adjustments summary: Update ClaimInvoiceAdjustment description: Updates a specific ClaimInvoiceAdjustment. operationId: UpdateClaimInvoiceAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimInvoiceAdjustmentKey in: path description: ClaimInvoiceAdjustment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustment' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustment' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Invoice Adjustments summary: Delete ClaimInvoiceAdjustment description: Deletes an ClaimInvoiceAdjustment operationId: DeleteClaimInvoiceAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimInvoiceAdjustmentKey in: path description: ClaimInvoiceAdjustment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice/{invoiceKey}/adjustments-batch': put: tags: - Claim Invoice Adjustments summary: Create or Update Batch ClaimInvoiceAdjustment description: 'Create or Update multiple ClaimInvoiceAdjustment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimInvoiceAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceAdjustment' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceAdjustment' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceAdjustment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-invoice-adjustment-reasons: post: tags: - Claim Invoice Adjustment Reasons summary: Create ClaimInvoiceAdjustmentReason description: Creates a new ClaimInvoiceAdjustmentReason operationId: CreateClaimInvoiceAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReason' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReason' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Invoice Adjustment Reasons summary: List ClaimInvoiceAdjustmentReason description: Lists all ClaimInvoiceAdjustmentReason operationId: ListClaimInvoiceAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReasonListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReasonListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReasonListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice-adjustment-reasons/{adjustmentReason}': get: tags: - Claim Invoice Adjustment Reasons summary: Get ClaimInvoiceAdjustmentReason description: Gets ClaimInvoiceAdjustmentReason operationId: GetClaimInvoiceAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: adjustmentReason in: path description: Adjustment Reason required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Invoice Adjustment Reasons summary: Update ClaimInvoiceAdjustmentReason description: Updates a specific ClaimInvoiceAdjustmentReason. operationId: UpdateClaimInvoiceAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: adjustmentReason in: path description: Adjustment Reason required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReason' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReason' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Invoice Adjustment Reasons summary: Delete ClaimInvoiceAdjustmentReason description: Deletes an ClaimInvoiceAdjustmentReason operationId: DeleteClaimInvoiceAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: adjustmentReason in: path description: Adjustment Reason required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-invoice-adjustment-reasons-batch: put: tags: - Claim Invoice Adjustment Reasons summary: Create or Update Batch ClaimInvoiceAdjustmentReason description: 'Create or Update multiple ClaimInvoiceAdjustmentReason at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimInvoiceAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReason' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReason' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReason' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-invoice-adjustment-received: post: tags: - Claim Invoice Adjustment Received summary: Create ClaimInvoiceAdjustmentReceived description: Creates a new ClaimInvoiceAdjustmentReceived operationId: CreateClaimInvoiceAdjustmentReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceived' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceived' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceived' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice-adjustment/{claimInvoiceAdjustmentKey}/received': get: tags: - Claim Invoice Adjustment Received summary: List ClaimInvoiceAdjustmentReceived description: Lists all ClaimInvoiceAdjustmentReceived for the given claimInvoiceAdjustmentKey operationId: ListClaimInvoiceAdjustmentReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimInvoiceAdjustmentKey in: path description: ClaimInvoiceAdjustment Key required: true schema: type: integer format: int32 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceivedListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceivedListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceivedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice-adjustment-received/{claimInvoiceAdjustmentReceivedKey}': get: tags: - Claim Invoice Adjustment Received summary: Get ClaimInvoiceAdjustmentReceived description: Gets ClaimInvoiceAdjustmentReceived operationId: GetClaimInvoiceAdjustmentReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimInvoiceAdjustmentReceivedKey in: path description: ClaimInvoiceAdjustmentReceived Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Invoice Adjustment Received summary: Update ClaimInvoiceAdjustmentReceived description: Updates a specific ClaimInvoiceAdjustmentReceived. operationId: UpdateClaimInvoiceAdjustmentReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimInvoiceAdjustmentReceivedKey in: path description: ClaimInvoiceAdjustmentReceived Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceived' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceived' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceived' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Invoice Adjustment Received summary: Delete ClaimInvoiceAdjustmentReceived description: Deletes an ClaimInvoiceAdjustmentReceived operationId: DeleteClaimInvoiceAdjustmentReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimInvoiceAdjustmentReceivedKey in: path description: ClaimInvoiceAdjustmentReceived Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-invoice-adjustment-received-batch: put: tags: - Claim Invoice Adjustment Received summary: Create or Update Batch ClaimInvoiceAdjustmentReceived description: 'Create or Update multiple ClaimInvoiceAdjustmentReceived at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimInvoiceAdjustmentReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceived' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceived' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceived' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-invoice-details: post: tags: - Claim Invoice Details summary: Create ClaimInvoiceDetail description: Creates a new ClaimInvoiceDetail operationId: CreateClaimInvoiceDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoiceDetail' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoiceDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice/{invoiceKey}/details': get: tags: - Claim Invoice Details summary: List ClaimInvoiceDetail description: Lists all ClaimInvoiceDetail for the given invoiceKey operationId: ListClaimInvoiceDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice/{invoiceKey}/details/{batchNumber}/{batchClaim}': get: tags: - Claim Invoice Details summary: Get ClaimInvoiceDetail description: Gets ClaimInvoiceDetail operationId: GetClaimInvoiceDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Invoice Details summary: Update ClaimInvoiceDetail description: Updates a specific ClaimInvoiceDetail. operationId: UpdateClaimInvoiceDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoiceDetail' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoiceDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Invoice Details summary: Delete ClaimInvoiceDetail description: Deletes an ClaimInvoiceDetail operationId: DeleteClaimInvoiceDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice/{invoiceKey}/details-batch': put: tags: - Claim Invoice Details summary: Create or Update Batch ClaimInvoiceDetail description: 'Create or Update multiple ClaimInvoiceDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimInvoiceDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice/{invoiceKey}/payments': post: tags: - Claim Invoice Payments summary: Create ClaimInvoicePayment description: Creates a new ClaimInvoicePayment operationId: CreateClaimInvoicePayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoicePayment' text/json: schema: $ref: '#/components/schemas/ClaimInvoicePayment' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoicePayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoicePaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoicePaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoicePaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Invoice Payments summary: List ClaimInvoicePayment description: Lists all ClaimInvoicePayment for the given invoiceKey operationId: ListClaimInvoicePayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoicePaymentListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoicePaymentListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoicePaymentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice/{invoiceKey}/payments/{claimPaymentKey}': get: tags: - Claim Invoice Payments summary: Get ClaimInvoicePayment description: Gets ClaimInvoicePayment operationId: GetClaimInvoicePayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: claimPaymentKey in: path description: ClaimPayment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoicePaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoicePaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoicePaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Invoice Payments summary: Update ClaimInvoicePayment description: Updates a specific ClaimInvoicePayment. operationId: UpdateClaimInvoicePayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: claimPaymentKey in: path description: ClaimPayment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoicePayment' text/json: schema: $ref: '#/components/schemas/ClaimInvoicePayment' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoicePayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoicePaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoicePaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoicePaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Invoice Payments summary: Delete ClaimInvoicePayment description: Deletes an ClaimInvoicePayment operationId: DeleteClaimInvoicePayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: claimPaymentKey in: path description: ClaimPayment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice/{invoiceKey}/payments-batch': put: tags: - Claim Invoice Payments summary: Create or Update Batch ClaimInvoicePayment description: 'Create or Update multiple ClaimInvoicePayment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimInvoicePayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoicePayment' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoicePayment' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoicePayment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-invoice-received: post: tags: - Claim Invoice Received summary: Create ClaimInvoiceReceived description: Creates a new ClaimInvoiceReceived operationId: CreateClaimInvoiceReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoiceReceived' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceReceived' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoiceReceived' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice/{invoiceKey}/received': get: tags: - Claim Invoice Received summary: List ClaimInvoiceReceived description: Lists all ClaimInvoiceReceived for the given invoiceKey operationId: ListClaimInvoiceReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceReceivedListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceReceivedListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceReceivedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice-received/{claimInvoiceReceivedKey}': get: tags: - Claim Invoice Received summary: Get ClaimInvoiceReceived description: Gets ClaimInvoiceReceived operationId: GetClaimInvoiceReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimInvoiceReceivedKey in: path description: ClaimInvoiceReceived Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Invoice Received summary: Update ClaimInvoiceReceived description: Updates a specific ClaimInvoiceReceived. operationId: UpdateClaimInvoiceReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimInvoiceReceivedKey in: path description: ClaimInvoiceReceived Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimInvoiceReceived' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceReceived' application/*+json: schema: $ref: '#/components/schemas/ClaimInvoiceReceived' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimInvoiceReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimInvoiceReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimInvoiceReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Invoice Received summary: Delete ClaimInvoiceReceived description: Deletes an ClaimInvoiceReceived operationId: DeleteClaimInvoiceReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimInvoiceReceivedKey in: path description: ClaimInvoiceReceived Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-invoice/{invoiceKey}/received-batch': put: tags: - Claim Invoice Received summary: Create or Update Batch ClaimInvoiceReceived description: 'Create or Update multiple ClaimInvoiceReceived at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimInvoiceReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceReceived' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceReceived' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimInvoiceReceived' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-occurrence-codes: post: tags: - Claim Occurrence Codes summary: Create ClaimOccurrenceCode description: Creates a new ClaimOccurrenceCode operationId: CreateClaimOccurrenceCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimOccurrenceCode' text/json: schema: $ref: '#/components/schemas/ClaimOccurrenceCode' application/*+json: schema: $ref: '#/components/schemas/ClaimOccurrenceCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimOccurrenceCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimOccurrenceCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimOccurrenceCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Occurrence Codes summary: List ClaimOccurrenceCode description: Lists all ClaimOccurrenceCode operationId: ListClaimOccurrenceCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimOccurrenceCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimOccurrenceCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimOccurrenceCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-occurrence-codes/{occurrenceCode}': get: tags: - Claim Occurrence Codes summary: Get ClaimOccurrenceCode description: Gets ClaimOccurrenceCode operationId: GetClaimOccurrenceCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: occurrenceCode in: path description: Occurrence Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimOccurrenceCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimOccurrenceCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimOccurrenceCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Occurrence Codes summary: Update ClaimOccurrenceCode description: Updates a specific ClaimOccurrenceCode. operationId: UpdateClaimOccurrenceCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: occurrenceCode in: path description: Occurrence Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimOccurrenceCode' text/json: schema: $ref: '#/components/schemas/ClaimOccurrenceCode' application/*+json: schema: $ref: '#/components/schemas/ClaimOccurrenceCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimOccurrenceCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimOccurrenceCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimOccurrenceCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Occurrence Codes summary: Delete ClaimOccurrenceCode description: Deletes an ClaimOccurrenceCode operationId: DeleteClaimOccurrenceCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: occurrenceCode in: path description: Occurrence Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-occurrence-codes-batch: put: tags: - Claim Occurrence Codes summary: Create or Update Batch ClaimOccurrenceCode description: 'Create or Update multiple ClaimOccurrenceCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimOccurrenceCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimOccurrenceCode' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimOccurrenceCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimOccurrenceCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-payments: post: tags: - Claim Payments summary: Create ClaimPayment description: Creates a new ClaimPayment operationId: CreateClaimPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimPayment' text/json: schema: $ref: '#/components/schemas/ClaimPayment' application/*+json: schema: $ref: '#/components/schemas/ClaimPayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Payments summary: List ClaimPayment description: Lists all ClaimPayment operationId: ListClaimPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPaymentListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPaymentListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPaymentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-payments/{claimPaymentKey}': get: tags: - Claim Payments summary: Get ClaimPayment description: Gets ClaimPayment operationId: GetClaimPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimPaymentKey in: path description: ClaimPayment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Payments summary: Update ClaimPayment description: Updates a specific ClaimPayment. operationId: UpdateClaimPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimPaymentKey in: path description: ClaimPayment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimPayment' text/json: schema: $ref: '#/components/schemas/ClaimPayment' application/*+json: schema: $ref: '#/components/schemas/ClaimPayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Payments summary: Delete ClaimPayment description: Deletes an ClaimPayment operationId: DeleteClaimPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimPaymentKey in: path description: ClaimPayment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-payments-batch: put: tags: - Claim Payments summary: Create or Update Batch ClaimPayment description: 'Create or Update multiple ClaimPayment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimPayment' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimPayment' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimPayment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-prebatches: post: tags: - Claim PreBatches summary: Create ClaimPreBatch description: Creates a new ClaimPreBatch operationId: CreateClaimPreBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimPreBatch' text/json: schema: $ref: '#/components/schemas/ClaimPreBatch' application/*+json: schema: $ref: '#/components/schemas/ClaimPreBatch' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPreBatchVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPreBatchVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPreBatchVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim PreBatches summary: List ClaimPreBatch description: Lists all ClaimPreBatch operationId: ListClaimPreBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPreBatchListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPreBatchListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPreBatchListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-prebatches/{ClaimPreBatch_Key}': get: tags: - Claim PreBatches summary: Get ClaimPreBatch description: Gets ClaimPreBatch operationId: GetClaimPreBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ClaimPreBatch_Key in: path description: ClaimPreBatch Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPreBatchVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPreBatchVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPreBatchVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim PreBatches summary: Update ClaimPreBatch description: Updates a specific ClaimPreBatch. operationId: UpdateClaimPreBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ClaimPreBatch_Key in: path description: ClaimPreBatch Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimPreBatch' text/json: schema: $ref: '#/components/schemas/ClaimPreBatch' application/*+json: schema: $ref: '#/components/schemas/ClaimPreBatch' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPreBatchVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPreBatchVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPreBatchVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim PreBatches summary: Delete ClaimPreBatch description: Deletes an ClaimPreBatch operationId: DeleteClaimPreBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ClaimPreBatch_Key in: path description: ClaimPreBatch Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-prebatches-batch: put: tags: - Claim PreBatches summary: Create or Update Batch ClaimPreBatch description: 'Create or Update multiple ClaimPreBatch at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimPreBatch parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimPreBatch' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimPreBatch' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimPreBatch' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-prebatch-details: post: tags: - Claim PreBatch Details summary: Create ClaimPreBatchDetail description: Creates a new ClaimPreBatchDetail operationId: CreateClaimPreBatchDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimPreBatchDetail' text/json: schema: $ref: '#/components/schemas/ClaimPreBatchDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimPreBatchDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPreBatchDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPreBatchDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPreBatchDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim PreBatch Details summary: List ClaimPreBatchDetail description: Lists all ClaimPreBatchDetail operationId: ListClaimPreBatchDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPreBatchDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPreBatchDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPreBatchDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-prebatch-details/{ClaimPreBatchDetail_Key}': get: tags: - Claim PreBatch Details summary: Get ClaimPreBatchDetail description: Gets ClaimPreBatchDetail operationId: GetClaimPreBatchDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ClaimPreBatchDetail_Key in: path description: ClaimPreBatchDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPreBatchDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPreBatchDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPreBatchDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim PreBatch Details summary: Update ClaimPreBatchDetail description: Updates a specific ClaimPreBatchDetail. operationId: UpdateClaimPreBatchDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ClaimPreBatchDetail_Key in: path description: ClaimPreBatchDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimPreBatchDetail' text/json: schema: $ref: '#/components/schemas/ClaimPreBatchDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimPreBatchDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPreBatchDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPreBatchDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPreBatchDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim PreBatch Details summary: Delete ClaimPreBatchDetail description: Deletes an ClaimPreBatchDetail operationId: DeleteClaimPreBatchDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ClaimPreBatchDetail_Key in: path description: ClaimPreBatchDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-prebatch-details-batch: put: tags: - Claim PreBatch Details summary: Create or Update Batch ClaimPreBatchDetail description: 'Create or Update multiple ClaimPreBatchDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimPreBatchDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimPreBatchDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimPreBatchDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimPreBatchDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-prompt-pays: post: tags: - Claim Prompt Pays summary: Create ClaimPromptPay description: Creates a new ClaimPromptPay operationId: CreateClaimPromptPay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimPromptPay' text/json: schema: $ref: '#/components/schemas/ClaimPromptPay' application/*+json: schema: $ref: '#/components/schemas/ClaimPromptPay' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPromptPayVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPromptPayVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPromptPayVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Prompt Pays summary: List ClaimPromptPay description: Lists all ClaimPromptPay operationId: ListClaimPromptPay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPromptPayListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPromptPayListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPromptPayListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-prompt-pays/{ClaimPromptPay_Key}': get: tags: - Claim Prompt Pays summary: Get ClaimPromptPay description: Gets ClaimPromptPay operationId: GetClaimPromptPay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ClaimPromptPay_Key in: path description: ClaimPromptPay Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPromptPayVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPromptPayVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPromptPayVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Prompt Pays summary: Update ClaimPromptPay description: Updates a specific ClaimPromptPay. operationId: UpdateClaimPromptPay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ClaimPromptPay_Key in: path description: ClaimPromptPay Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimPromptPay' text/json: schema: $ref: '#/components/schemas/ClaimPromptPay' application/*+json: schema: $ref: '#/components/schemas/ClaimPromptPay' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimPromptPayVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimPromptPayVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimPromptPayVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Prompt Pays summary: Delete ClaimPromptPay description: Deletes an ClaimPromptPay operationId: DeleteClaimPromptPay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ClaimPromptPay_Key in: path description: ClaimPromptPay Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-prompt-pays-batch: put: tags: - Claim Prompt Pays summary: Create or Update Batch ClaimPromptPay description: 'Create or Update multiple ClaimPromptPay at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimPromptPay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimPromptPay' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimPromptPay' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimPromptPay' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queues: post: tags: - Claim Queues summary: Create ClaimQueue description: Creates a new ClaimQueue operationId: CreateClaimQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueue' text/json: schema: $ref: '#/components/schemas/ClaimQueue' application/*+json: schema: $ref: '#/components/schemas/ClaimQueue' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Queues summary: List ClaimQueue description: Lists all ClaimQueue operationId: ListClaimQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queues/{claimQueue_Key}': get: tags: - Claim Queues summary: Get ClaimQueue description: Gets ClaimQueue operationId: GetClaimQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueue_Key in: path description: ClaimQueue Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Queues summary: Update ClaimQueue description: Updates a specific ClaimQueue. operationId: UpdateClaimQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueue_Key in: path description: ClaimQueue Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueue' text/json: schema: $ref: '#/components/schemas/ClaimQueue' application/*+json: schema: $ref: '#/components/schemas/ClaimQueue' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Queues summary: Delete ClaimQueue description: Deletes an ClaimQueue operationId: DeleteClaimQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueue_Key in: path description: ClaimQueue Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queues-batch: put: tags: - Claim Queues summary: Create or Update Batch ClaimQueue description: 'Create or Update multiple ClaimQueue at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueue' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueue' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimQueue' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queues/{claimQueueKey}/details': post: tags: - Claim Queue Details summary: Create ClaimQueueDetail description: Creates a new ClaimQueueDetail operationId: CreateClaimQueueDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueDetail' text/json: schema: $ref: '#/components/schemas/ClaimQueueDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Queue Details summary: List ClaimQueueDetail description: Lists all ClaimQueueDetail for the given claimQueueKey operationId: ListClaimQueueDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queues/{claimQueueKey}/details/{batchNumber}/{batchClaim}': get: tags: - Claim Queue Details summary: Get ClaimQueueDetail description: Gets ClaimQueueDetail operationId: GetClaimQueueDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Queue Details summary: Update ClaimQueueDetail description: Updates a specific ClaimQueueDetail. operationId: UpdateClaimQueueDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueDetail' text/json: schema: $ref: '#/components/schemas/ClaimQueueDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Queue Details summary: Delete ClaimQueueDetail description: Deletes an ClaimQueueDetail operationId: DeleteClaimQueueDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queues/{claimQueueKey}/details-batch': put: tags: - Claim Queue Details summary: Create or Update Batch ClaimQueueDetail description: 'Create or Update multiple ClaimQueueDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimQueueDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-logs: post: tags: - Claim Queue Logs summary: Create ClaimQueueLog description: Creates a new ClaimQueueLog operationId: CreateClaimQueueLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueLog' text/json: schema: $ref: '#/components/schemas/ClaimQueueLog' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueLog' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueLogVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueLogVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Queue Logs summary: List ClaimQueueLog description: Lists all ClaimQueueLog operationId: ListClaimQueueLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueLogListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueLogListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueLogListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queue-logs/{claimQueueLogKey}': get: tags: - Claim Queue Logs summary: Get ClaimQueueLog description: Gets ClaimQueueLog operationId: GetClaimQueueLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueLogKey in: path description: ClaimQueueLog Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueLogVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueLogVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Queue Logs summary: Update ClaimQueueLog description: Updates a specific ClaimQueueLog. operationId: UpdateClaimQueueLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueLogKey in: path description: ClaimQueueLog Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueLog' text/json: schema: $ref: '#/components/schemas/ClaimQueueLog' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueLog' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueLogVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueLogVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Queue Logs summary: Delete ClaimQueueLog description: Deletes an ClaimQueueLog operationId: DeleteClaimQueueLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueLogKey in: path description: ClaimQueueLog Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-logs-batch: put: tags: - Claim Queue Logs summary: Create or Update Batch ClaimQueueLog description: 'Create or Update multiple ClaimQueueLog at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimQueueLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueLog' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueLog' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueLog' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queues/{claimQueueKey}/notify-user-groups': post: tags: - Claim Queue Notify User Groups summary: Create ClaimQueueNotifyGroup description: Creates a new ClaimQueueNotifyGroup operationId: CreateClaimQueueNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyGroup' text/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyGroup' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueNotifyGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueNotifyGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Queue Notify User Groups summary: List ClaimQueueNotifyGroup description: Lists all ClaimQueueNotifyGroup for the given claimQueueKey operationId: ListClaimQueueNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueNotifyGroupListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyGroupListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyGroupListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queues/{claimQueueKey}/notify-user-groups/{userGroupKey}': get: tags: - Claim Queue Notify User Groups summary: Get ClaimQueueNotifyGroup description: Gets ClaimQueueNotifyGroup operationId: GetClaimQueueNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueNotifyGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Queue Notify User Groups summary: Delete ClaimQueueNotifyGroup description: Deletes an ClaimQueueNotifyGroup operationId: DeleteClaimQueueNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queues/{claimQueueKey}/notify-user-groups-batch': put: tags: - Claim Queue Notify User Groups summary: Create or Update Batch ClaimQueueNotifyGroup description: 'Create or Update multiple ClaimQueueNotifyGroup at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimQueueNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueNotifyGroup' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueNotifyGroup' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueNotifyGroup' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queues/{claimQueueKey}/notify-users': post: tags: - Claim Queue Notify Users summary: Create ClaimQueueNotifyUser description: Creates a new ClaimQueueNotifyUser operationId: CreateClaimQueueNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyUser' text/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyUser' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueNotifyUser' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueNotifyUserVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyUserVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Queue Notify Users summary: List ClaimQueueNotifyUser description: Lists all ClaimQueueNotifyUser for the given claimQueueKey operationId: ListClaimQueueNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueNotifyUserListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyUserListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyUserListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queues/{claimQueueKey}/notify-users/{userID}': get: tags: - Claim Queue Notify Users summary: Get ClaimQueueNotifyUser description: Gets ClaimQueueNotifyUser operationId: GetClaimQueueNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueNotifyUserVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyUserVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueNotifyUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Queue Notify Users summary: Delete ClaimQueueNotifyUser description: Deletes an ClaimQueueNotifyUser operationId: DeleteClaimQueueNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queues/{claimQueueKey}/notify-users-batch': put: tags: - Claim Queue Notify Users summary: Create or Update Batch ClaimQueueNotifyUser description: 'Create or Update multiple ClaimQueueNotifyUser at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimQueueNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueKey in: path description: ClaimQueue Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueNotifyUser' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueNotifyUser' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueNotifyUser' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-priorities: post: tags: - Claim Queue Priorities summary: Create ClaimQueuePriority description: Creates a new ClaimQueuePriority operationId: CreateClaimQueuePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueuePriority' text/json: schema: $ref: '#/components/schemas/ClaimQueuePriority' application/*+json: schema: $ref: '#/components/schemas/ClaimQueuePriority' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueuePriorityVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueuePriorityVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueuePriorityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Queue Priorities summary: List ClaimQueuePriority description: Lists all ClaimQueuePriority operationId: ListClaimQueuePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueuePriorityListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueuePriorityListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueuePriorityListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queue-priorities/{queuePriority}': get: tags: - Claim Queue Priorities summary: Get ClaimQueuePriority description: Gets ClaimQueuePriority operationId: GetClaimQueuePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: queuePriority in: path description: Queue Priority required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueuePriorityVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueuePriorityVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueuePriorityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Queue Priorities summary: Update ClaimQueuePriority description: Updates a specific ClaimQueuePriority. operationId: UpdateClaimQueuePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: queuePriority in: path description: Queue Priority required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueuePriority' text/json: schema: $ref: '#/components/schemas/ClaimQueuePriority' application/*+json: schema: $ref: '#/components/schemas/ClaimQueuePriority' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueuePriorityVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueuePriorityVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueuePriorityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Queue Priorities summary: Delete ClaimQueuePriority description: Deletes an ClaimQueuePriority operationId: DeleteClaimQueuePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: queuePriority in: path description: Queue Priority required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-priorities-batch: put: tags: - Claim Queue Priorities summary: Create or Update Batch ClaimQueuePriority description: 'Create or Update multiple ClaimQueuePriority at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimQueuePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueuePriority' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueuePriority' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimQueuePriority' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-processors: post: tags: - Claim Queue Processors summary: Create ClaimQueueProcessor description: Creates a new ClaimQueueProcessor operationId: CreateClaimQueueProcessor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueProcessor' text/json: schema: $ref: '#/components/schemas/ClaimQueueProcessor' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueProcessor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueProcessorVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueProcessorVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueProcessorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Queue Processors summary: List ClaimQueueProcessor description: Lists all ClaimQueueProcessor operationId: ListClaimQueueProcessor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueProcessorListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueProcessorListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueProcessorListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queue-processors/{claimQueueProcessorKey}': get: tags: - Claim Queue Processors summary: Get ClaimQueueProcessor description: Gets ClaimQueueProcessor operationId: GetClaimQueueProcessor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueProcessorKey in: path description: ClaimQueueProcessor Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueProcessorVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueProcessorVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueProcessorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Queue Processors summary: Update ClaimQueueProcessor description: Updates a specific ClaimQueueProcessor. operationId: UpdateClaimQueueProcessor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueProcessorKey in: path description: ClaimQueueProcessor Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueProcessor' text/json: schema: $ref: '#/components/schemas/ClaimQueueProcessor' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueProcessor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueProcessorVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueProcessorVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueProcessorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Queue Processors summary: Delete ClaimQueueProcessor description: Deletes an ClaimQueueProcessor operationId: DeleteClaimQueueProcessor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueProcessorKey in: path description: ClaimQueueProcessor Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-processors-batch: put: tags: - Claim Queue Processors summary: Create or Update Batch ClaimQueueProcessor description: 'Create or Update multiple ClaimQueueProcessor at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimQueueProcessor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueProcessor' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueProcessor' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueProcessor' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-process-tracking: post: tags: - Claim Queue Process Tracking summary: Create ClaimQueueProcessTrack description: Creates a new ClaimQueueProcessTrack operationId: CreateClaimQueueProcessTrack parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrack' text/json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrack' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrack' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueProcessTrackVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrackVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrackVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Queue Process Tracking summary: List ClaimQueueProcessTrack description: Lists all ClaimQueueProcessTrack operationId: ListClaimQueueProcessTrack parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueProcessTrackListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrackListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrackListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queue-process-tracking/{subscriberID}': get: tags: - Claim Queue Process Tracking summary: Get ClaimQueueProcessTrack description: Gets ClaimQueueProcessTrack operationId: GetClaimQueueProcessTrack parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueProcessTrackVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrackVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrackVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Queue Process Tracking summary: Update ClaimQueueProcessTrack description: Updates a specific ClaimQueueProcessTrack. operationId: UpdateClaimQueueProcessTrack parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrack' text/json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrack' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrack' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueProcessTrackVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrackVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueProcessTrackVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Queue Process Tracking summary: Delete ClaimQueueProcessTrack description: Deletes an ClaimQueueProcessTrack operationId: DeleteClaimQueueProcessTrack parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-process-tracking-batch: put: tags: - Claim Queue Process Tracking summary: Create or Update Batch ClaimQueueProcessTrack description: 'Create or Update multiple ClaimQueueProcessTrack at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimQueueProcessTrack parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueProcessTrack' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueProcessTrack' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueProcessTrack' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-results: post: tags: - Claim Queue Results summary: Create ClaimQueueResult description: Creates a new ClaimQueueResult operationId: CreateClaimQueueResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueResult' text/json: schema: $ref: '#/components/schemas/ClaimQueueResult' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueResult' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueResultVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueResultVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueResultVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Queue Results summary: List ClaimQueueResult description: Lists all ClaimQueueResult operationId: ListClaimQueueResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueResultListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueResultListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueResultListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queue-results/{queueResult}': get: tags: - Claim Queue Results summary: Get ClaimQueueResult description: Gets ClaimQueueResult operationId: GetClaimQueueResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: queueResult in: path description: Queue Result required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueResultVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueResultVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueResultVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Queue Results summary: Update ClaimQueueResult description: Updates a specific ClaimQueueResult. operationId: UpdateClaimQueueResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: queueResult in: path description: Queue Result required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueResult' text/json: schema: $ref: '#/components/schemas/ClaimQueueResult' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueResult' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueResultVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueResultVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueResultVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Queue Results summary: Delete ClaimQueueResult description: Deletes an ClaimQueueResult operationId: DeleteClaimQueueResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: queueResult in: path description: Queue Result required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-results-batch: put: tags: - Claim Queue Results summary: Create or Update Batch ClaimQueueResult description: 'Create or Update multiple ClaimQueueResult at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimQueueResult parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueResult' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueResult' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueResult' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-schedules: post: tags: - Claim Queue Schedules summary: Create ClaimQueueSchedule description: Creates a new ClaimQueueSchedule operationId: CreateClaimQueueSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueSchedule' text/json: schema: $ref: '#/components/schemas/ClaimQueueSchedule' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Queue Schedules summary: List ClaimQueueSchedule description: Lists all ClaimQueueSchedule operationId: ListClaimQueueSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueScheduleListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queue-schedules/{claimQueueScheduleKey}': get: tags: - Claim Queue Schedules summary: Get ClaimQueueSchedule description: Gets ClaimQueueSchedule operationId: GetClaimQueueSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueScheduleKey in: path description: ClaimQueueSchedule Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Queue Schedules summary: Update ClaimQueueSchedule description: Updates a specific ClaimQueueSchedule. operationId: UpdateClaimQueueSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueScheduleKey in: path description: ClaimQueueSchedule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueSchedule' text/json: schema: $ref: '#/components/schemas/ClaimQueueSchedule' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Queue Schedules summary: Delete ClaimQueueSchedule description: Deletes an ClaimQueueSchedule operationId: DeleteClaimQueueSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueScheduleKey in: path description: ClaimQueueSchedule Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-schedules-batch: put: tags: - Claim Queue Schedules summary: Create or Update Batch ClaimQueueSchedule description: 'Create or Update multiple ClaimQueueSchedule at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimQueueSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueSchedule' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueSchedule' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueSchedule' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queue-schedules/{claimQueueScheduleKey}/notify-user-groups': post: tags: - Claim Queue Schedule Notify User Groups summary: Create ClaimQueueScheduleNotifyGroup description: Creates a new ClaimQueueScheduleNotifyGroup operationId: CreateClaimQueueScheduleNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueScheduleKey in: path description: ClaimQueueSchedule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroup' text/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroup' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Queue Schedule Notify User Groups summary: List ClaimQueueScheduleNotifyGroup description: Lists all ClaimQueueScheduleNotifyGroup for the given claimQueueScheduleKey operationId: ListClaimQueueScheduleNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueScheduleKey in: path description: ClaimQueueSchedule Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroupListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroupListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroupListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queue-schedules/{claimQueueScheduleKey}/notify-user-groups/{userGroupKey}': get: tags: - Claim Queue Schedule Notify User Groups summary: Get ClaimQueueScheduleNotifyGroup description: Gets ClaimQueueScheduleNotifyGroup operationId: GetClaimQueueScheduleNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueScheduleKey in: path description: ClaimQueueSchedule Key required: true schema: type: integer format: int32 - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Queue Schedule Notify User Groups summary: Delete ClaimQueueScheduleNotifyGroup description: Deletes an ClaimQueueScheduleNotifyGroup operationId: DeleteClaimQueueScheduleNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueScheduleKey in: path description: ClaimQueueSchedule Key required: true schema: type: integer format: int32 - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queue-schedules/{claimQueueScheduleKey}/notify-user-groups-batch': put: tags: - Claim Queue Schedule Notify User Groups summary: Create or Update Batch ClaimQueueScheduleNotifyGroup description: 'Create or Update multiple ClaimQueueScheduleNotifyGroup at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimQueueScheduleNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueScheduleKey in: path description: ClaimQueueSchedule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroup' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroup' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroup' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queue-schedules/{claimQueueScheduleKey}/notify-users': post: tags: - Claim Queue Schedule Notify Users summary: Create ClaimQueueScheduleNotifyUser description: Creates a new ClaimQueueScheduleNotifyUser operationId: CreateClaimQueueScheduleNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueScheduleKey in: path description: ClaimQueueSchedule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUser' text/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUser' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUser' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUserVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUserVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Queue Schedule Notify Users summary: List ClaimQueueScheduleNotifyUser description: Lists all ClaimQueueScheduleNotifyUser for the given claimQueueScheduleKey operationId: ListClaimQueueScheduleNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueScheduleKey in: path description: ClaimQueueSchedule Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUserListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUserListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUserListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queue-schedules/{claimQueueScheduleKey}/notify-users/{userID}': get: tags: - Claim Queue Schedule Notify Users summary: Get ClaimQueueScheduleNotifyUser description: Gets ClaimQueueScheduleNotifyUser operationId: GetClaimQueueScheduleNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueScheduleKey in: path description: ClaimQueueSchedule Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUserVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUserVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Queue Schedule Notify Users summary: Delete ClaimQueueScheduleNotifyUser description: Deletes an ClaimQueueScheduleNotifyUser operationId: DeleteClaimQueueScheduleNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueScheduleKey in: path description: ClaimQueueSchedule Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queue-schedules/{claimQueueScheduleKey}/notify-users-batch': put: tags: - Claim Queue Schedule Notify Users summary: Create or Update Batch ClaimQueueScheduleNotifyUser description: 'Create or Update multiple ClaimQueueScheduleNotifyUser at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimQueueScheduleNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimQueueScheduleKey in: path description: ClaimQueueSchedule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUser' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUser' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUser' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-statuses: post: tags: - Claim Queue Statuses summary: Create ClaimQueueStatus description: Creates a new ClaimQueueStatus operationId: CreateClaimQueueStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueStatus' text/json: schema: $ref: '#/components/schemas/ClaimQueueStatus' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Queue Statuses summary: List ClaimQueueStatus description: Lists all ClaimQueueStatus operationId: ListClaimQueueStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-queue-statuses/{queueStatus}': get: tags: - Claim Queue Statuses summary: Get ClaimQueueStatus description: Gets ClaimQueueStatus operationId: GetClaimQueueStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: queueStatus in: path description: Queue Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Queue Statuses summary: Update ClaimQueueStatus description: Updates a specific ClaimQueueStatus. operationId: UpdateClaimQueueStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: queueStatus in: path description: Queue Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimQueueStatus' text/json: schema: $ref: '#/components/schemas/ClaimQueueStatus' application/*+json: schema: $ref: '#/components/schemas/ClaimQueueStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimQueueStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimQueueStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimQueueStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Queue Statuses summary: Delete ClaimQueueStatus description: Deletes an ClaimQueueStatus operationId: DeleteClaimQueueStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: queueStatus in: path description: Queue Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-statuses-batch: put: tags: - Claim Queue Statuses summary: Create or Update Batch ClaimQueueStatus description: 'Create or Update multiple ClaimQueueStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimQueueStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimQueueStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-reprice-remove: post: tags: - Claim Reprice Remove summary: Create ClaimRepriceRemove description: Creates a new ClaimRepriceRemove operationId: CreateClaimRepriceRemove parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRepriceRemove' text/json: schema: $ref: '#/components/schemas/ClaimRepriceRemove' application/*+json: schema: $ref: '#/components/schemas/ClaimRepriceRemove' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRepriceRemoveVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRepriceRemoveVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRepriceRemoveVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Reprice Remove summary: List ClaimRepriceRemove description: Lists all ClaimRepriceRemove operationId: ListClaimRepriceRemove parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRepriceRemoveListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRepriceRemoveListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRepriceRemoveListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-reprice-remove/{ClaimRepriceRemove_Key}': get: tags: - Claim Reprice Remove summary: Get ClaimRepriceRemove description: Gets ClaimRepriceRemove operationId: GetClaimRepriceRemove parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ClaimRepriceRemove_Key in: path description: ClaimRepriceRemove Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRepriceRemoveVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRepriceRemoveVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRepriceRemoveVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Reprice Remove summary: Update ClaimRepriceRemove description: Updates a specific ClaimRepriceRemove. operationId: UpdateClaimRepriceRemove parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ClaimRepriceRemove_Key in: path description: ClaimRepriceRemove Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRepriceRemove' text/json: schema: $ref: '#/components/schemas/ClaimRepriceRemove' application/*+json: schema: $ref: '#/components/schemas/ClaimRepriceRemove' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRepriceRemoveVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRepriceRemoveVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRepriceRemoveVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Reprice Remove summary: Delete ClaimRepriceRemove description: Deletes an ClaimRepriceRemove operationId: DeleteClaimRepriceRemove parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ClaimRepriceRemove_Key in: path description: ClaimRepriceRemove Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-reprice-remove-batch: put: tags: - Claim Reprice Remove summary: Create or Update Batch ClaimRepriceRemove description: 'Create or Update multiple ClaimRepriceRemove at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimRepriceRemove parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimRepriceRemove' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimRepriceRemove' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimRepriceRemove' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-rules: post: tags: - Claim Rules summary: Create ClaimRule description: Creates a new ClaimRule operationId: CreateClaimRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRule' text/json: schema: $ref: '#/components/schemas/ClaimRule' application/*+json: schema: $ref: '#/components/schemas/ClaimRule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Rules summary: List ClaimRule description: Lists all ClaimRule operationId: ListClaimRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rules/{claimRuleKey}': get: tags: - Claim Rules summary: Get ClaimRule description: Gets ClaimRule operationId: GetClaimRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Rules summary: Update ClaimRule description: Updates a specific ClaimRule. operationId: UpdateClaimRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRule' text/json: schema: $ref: '#/components/schemas/ClaimRule' application/*+json: schema: $ref: '#/components/schemas/ClaimRule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Rules summary: Delete ClaimRule description: Deletes an ClaimRule operationId: DeleteClaimRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-rules-batch: put: tags: - Claim Rules summary: Create or Update Batch ClaimRule description: 'Create or Update multiple ClaimRule at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimRule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimRule' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimRule' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimRule' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rules/{claimRuleKey}/types': post: tags: - Claim Rule Types summary: Create ClaimRuleClaimType description: Creates a new ClaimRuleClaimType operationId: CreateClaimRuleClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRuleClaimType' text/json: schema: $ref: '#/components/schemas/ClaimRuleClaimType' application/*+json: schema: $ref: '#/components/schemas/ClaimRuleClaimType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleClaimTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleClaimTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleClaimTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Rule Types summary: List ClaimRuleClaimType description: Lists all ClaimRuleClaimType for the given claimRuleKey operationId: ListClaimRuleClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleClaimTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleClaimTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleClaimTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rules/{claimRuleKey}/types/{claimType}': get: tags: - Claim Rule Types summary: Get ClaimRuleClaimType description: Gets ClaimRuleClaimType operationId: GetClaimRuleClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: claimType in: path description: Claim Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleClaimTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleClaimTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleClaimTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Rule Types summary: Update ClaimRuleClaimType description: Updates a specific ClaimRuleClaimType. operationId: UpdateClaimRuleClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: claimType in: path description: Claim Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRuleClaimType' text/json: schema: $ref: '#/components/schemas/ClaimRuleClaimType' application/*+json: schema: $ref: '#/components/schemas/ClaimRuleClaimType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleClaimTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleClaimTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleClaimTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Rule Types summary: Delete ClaimRuleClaimType description: Deletes an ClaimRuleClaimType operationId: DeleteClaimRuleClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: claimType in: path description: Claim Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rules/{claimRuleKey}/types-batch': put: tags: - Claim Rule Types summary: Create or Update Batch ClaimRuleClaimType description: 'Create or Update multiple ClaimRuleClaimType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimRuleClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleClaimType' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleClaimType' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleClaimType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rules/{claimRuleKey}/dependent-claim-rules': post: tags: - Claim Rule Dependents summary: Create ClaimRuleDependent description: Creates a new ClaimRuleDependent operationId: CreateClaimRuleDependent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRuleDependent' text/json: schema: $ref: '#/components/schemas/ClaimRuleDependent' application/*+json: schema: $ref: '#/components/schemas/ClaimRuleDependent' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleDependentVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleDependentVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleDependentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Rule Dependents summary: List ClaimRuleDependent description: Lists all ClaimRuleDependent for the given claimRuleKey operationId: ListClaimRuleDependent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleDependentListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleDependentListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleDependentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rules/{claimRuleKey}/dependent-claim-rules/{dependentClaimRuleKey}': get: tags: - Claim Rule Dependents summary: Get ClaimRuleDependent description: Gets ClaimRuleDependent operationId: GetClaimRuleDependent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: dependentClaimRuleKey in: path description: Dependent ClaimRule Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleDependentVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleDependentVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleDependentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Rule Dependents summary: Delete ClaimRuleDependent description: Deletes an ClaimRuleDependent operationId: DeleteClaimRuleDependent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: dependentClaimRuleKey in: path description: Dependent ClaimRule Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rules/{claimRuleKey}/dependent-claim-rules-batch': put: tags: - Claim Rule Dependents summary: Create or Update Batch ClaimRuleDependent description: 'Create or Update multiple ClaimRuleDependent at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimRuleDependent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleDependent' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleDependent' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleDependent' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rules/{claimRuleKey}/procedures': post: tags: - Claim Rule Procedures summary: Create ClaimRuleProcedure description: Creates a new ClaimRuleProcedure operationId: CreateClaimRuleProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRuleProcedure' text/json: schema: $ref: '#/components/schemas/ClaimRuleProcedure' application/*+json: schema: $ref: '#/components/schemas/ClaimRuleProcedure' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Rule Procedures summary: List ClaimRuleProcedure description: Lists all ClaimRuleProcedure for the given claimRuleKey operationId: ListClaimRuleProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleProcedureListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleProcedureListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleProcedureListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rules/{claimRuleKey}/procedures/{fromProcedure}': get: tags: - Claim Rule Procedures summary: Get ClaimRuleProcedure description: Gets ClaimRuleProcedure operationId: GetClaimRuleProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: fromProcedure in: path description: From Procedure required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Rule Procedures summary: Update ClaimRuleProcedure description: Updates a specific ClaimRuleProcedure. operationId: UpdateClaimRuleProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: fromProcedure in: path description: From Procedure required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRuleProcedure' text/json: schema: $ref: '#/components/schemas/ClaimRuleProcedure' application/*+json: schema: $ref: '#/components/schemas/ClaimRuleProcedure' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Rule Procedures summary: Delete ClaimRuleProcedure description: Deletes an ClaimRuleProcedure operationId: DeleteClaimRuleProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: fromProcedure in: path description: From Procedure required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rules/{claimRuleKey}/procedures-batch': put: tags: - Claim Rule Procedures summary: Create or Update Batch ClaimRuleProcedure description: 'Create or Update multiple ClaimRuleProcedure at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimRuleProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleProcedure' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleProcedure' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleProcedure' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rules/{claimRuleKey}/provider-types': post: tags: - Claim Rule Provider Types summary: Create ClaimRuleProviderType description: Creates a new ClaimRuleProviderType operationId: CreateClaimRuleProviderType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRuleProviderType' text/json: schema: $ref: '#/components/schemas/ClaimRuleProviderType' application/*+json: schema: $ref: '#/components/schemas/ClaimRuleProviderType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleProviderTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleProviderTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleProviderTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Rule Provider Types summary: List ClaimRuleProviderType description: Lists all ClaimRuleProviderType for the given claimRuleKey operationId: ListClaimRuleProviderType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleProviderTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleProviderTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleProviderTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rules/{claimRuleKey}/provider-types/{providerType}': get: tags: - Claim Rule Provider Types summary: Get ClaimRuleProviderType description: Gets ClaimRuleProviderType operationId: GetClaimRuleProviderType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: providerType in: path description: Provider Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleProviderTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleProviderTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleProviderTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Rule Provider Types summary: Update ClaimRuleProviderType description: Updates a specific ClaimRuleProviderType. operationId: UpdateClaimRuleProviderType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: providerType in: path description: Provider Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRuleProviderType' text/json: schema: $ref: '#/components/schemas/ClaimRuleProviderType' application/*+json: schema: $ref: '#/components/schemas/ClaimRuleProviderType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleProviderTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleProviderTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleProviderTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Rule Provider Types summary: Delete ClaimRuleProviderType description: Deletes an ClaimRuleProviderType operationId: DeleteClaimRuleProviderType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 - name: providerType in: path description: Provider Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rules/{claimRuleKey}/provider-types-batch': put: tags: - Claim Rule Provider Types summary: Create or Update Batch ClaimRuleProviderType description: 'Create or Update multiple ClaimRuleProviderType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimRuleProviderType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleProviderType' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleProviderType' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleProviderType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rule-set-headers/{claimRuleSetHeaderKey}/details': post: tags: - Claim Rule Set Details summary: Create ClaimRuleSetDetail description: Creates a new ClaimRuleSetDetail operationId: CreateClaimRuleSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleSetHeaderKey in: path description: ClaimRuleSetHeader Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRuleSetDetail' text/json: schema: $ref: '#/components/schemas/ClaimRuleSetDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimRuleSetDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleSetDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleSetDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleSetDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Rule Set Details summary: List ClaimRuleSetDetail description: Lists all ClaimRuleSetDetail for the given claimRuleSetHeaderKey operationId: ListClaimRuleSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleSetHeaderKey in: path description: ClaimRuleSetHeader Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleSetDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleSetDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleSetDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rule-set-headers/{claimRuleSetHeaderKey}/details/{claimRuleKey}': get: tags: - Claim Rule Set Details summary: Get ClaimRuleSetDetail description: Gets ClaimRuleSetDetail operationId: GetClaimRuleSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleSetHeaderKey in: path description: ClaimRuleSetHeader Key required: true schema: type: integer format: int32 - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleSetDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleSetDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleSetDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Rule Set Details summary: Update ClaimRuleSetDetail description: Updates a specific ClaimRuleSetDetail. operationId: UpdateClaimRuleSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleSetHeaderKey in: path description: ClaimRuleSetHeader Key required: true schema: type: integer format: int32 - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRuleSetDetail' text/json: schema: $ref: '#/components/schemas/ClaimRuleSetDetail' application/*+json: schema: $ref: '#/components/schemas/ClaimRuleSetDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleSetDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleSetDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleSetDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Rule Set Details summary: Delete ClaimRuleSetDetail description: Deletes an ClaimRuleSetDetail operationId: DeleteClaimRuleSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleSetHeaderKey in: path description: ClaimRuleSetHeader Key required: true schema: type: integer format: int32 - name: claimRuleKey in: path description: ClaimRule Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rule-set-headers/{claimRuleSetHeaderKey}/details-batch': put: tags: - Claim Rule Set Details summary: Create or Update Batch ClaimRuleSetDetail description: 'Create or Update multiple ClaimRuleSetDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimRuleSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleSetHeaderKey in: path description: ClaimRuleSetHeader Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleSetDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleSetDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleSetDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-rule-set-headers: post: tags: - Claim Rule Set Headers summary: Create ClaimRuleSetHeader description: Creates a new ClaimRuleSetHeader operationId: CreateClaimRuleSetHeader parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRuleSetHeader' text/json: schema: $ref: '#/components/schemas/ClaimRuleSetHeader' application/*+json: schema: $ref: '#/components/schemas/ClaimRuleSetHeader' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleSetHeaderVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleSetHeaderVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleSetHeaderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Rule Set Headers summary: List ClaimRuleSetHeader description: Lists all ClaimRuleSetHeader operationId: ListClaimRuleSetHeader parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleSetHeaderListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleSetHeaderListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleSetHeaderListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-rule-set-headers/{claimRuleSetHeaderKey}': get: tags: - Claim Rule Set Headers summary: Get ClaimRuleSetHeader description: Gets ClaimRuleSetHeader operationId: GetClaimRuleSetHeader parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleSetHeaderKey in: path description: ClaimRuleSetHeader Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleSetHeaderVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleSetHeaderVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleSetHeaderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Rule Set Headers summary: Update ClaimRuleSetHeader description: Updates a specific ClaimRuleSetHeader. operationId: UpdateClaimRuleSetHeader parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleSetHeaderKey in: path description: ClaimRuleSetHeader Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimRuleSetHeader' text/json: schema: $ref: '#/components/schemas/ClaimRuleSetHeader' application/*+json: schema: $ref: '#/components/schemas/ClaimRuleSetHeader' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimRuleSetHeaderVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimRuleSetHeaderVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimRuleSetHeaderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Rule Set Headers summary: Delete ClaimRuleSetHeader description: Deletes an ClaimRuleSetHeader operationId: DeleteClaimRuleSetHeader parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimRuleSetHeaderKey in: path description: ClaimRuleSetHeader Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-rule-set-headers-batch: put: tags: - Claim Rule Set Headers summary: Create or Update Batch ClaimRuleSetHeader description: 'Create or Update multiple ClaimRuleSetHeader at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimRuleSetHeader parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleSetHeader' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleSetHeader' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimRuleSetHeader' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-statuses: post: tags: - Claim Statuses summary: Create ClaimStatus description: Creates a new ClaimStatus operationId: CreateClaimStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimStatus' text/json: schema: $ref: '#/components/schemas/ClaimStatus' application/*+json: schema: $ref: '#/components/schemas/ClaimStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Statuses summary: List ClaimStatus description: Lists all ClaimStatus operationId: ListClaimStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-statuses/{claimStatus}': get: tags: - Claim Statuses summary: Get ClaimStatus description: Gets ClaimStatus operationId: GetClaimStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimStatus in: path description: Claim Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Statuses summary: Update ClaimStatus description: Updates a specific ClaimStatus. operationId: UpdateClaimStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimStatus in: path description: Claim Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimStatus' text/json: schema: $ref: '#/components/schemas/ClaimStatus' application/*+json: schema: $ref: '#/components/schemas/ClaimStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Statuses summary: Delete ClaimStatus description: Deletes an ClaimStatus operationId: DeleteClaimStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimStatus in: path description: Claim Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-statuses-batch: put: tags: - Claim Statuses summary: Create or Update Batch ClaimStatus description: 'Create or Update multiple ClaimStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-timeline: get: tags: - Claims summary: List ClaimTimeline description: Lists all ClaimTimeline operationId: ListClaimTimeline parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batch-id in: query description: Batch ID required: true schema: type: integer format: int32 - name: batch-claim-id in: query description: Batch Claim ID required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_ClaimTimelineListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_ClaimTimelineListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_ClaimTimelineListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/transactions': post: tags: - Claim Transactions summary: Create ClaimTransaction description: Creates a new ClaimTransaction operationId: CreateClaimTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimTransaction' text/json: schema: $ref: '#/components/schemas/ClaimTransaction' application/*+json: schema: $ref: '#/components/schemas/ClaimTransaction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimTransactionVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimTransactionVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimTransactionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Transactions summary: List ClaimTransaction description: Lists all ClaimTransaction for the given batchNumber and batchClaim operationId: ListClaimTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimTransactionListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimTransactionListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimTransactionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/transactions/{claimTransactionKey}': get: tags: - Claim Transactions summary: Get ClaimTransaction description: Gets ClaimTransaction operationId: GetClaimTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimTransactionKey in: path description: ClaimTransaction Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimTransactionVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimTransactionVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimTransactionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Transactions summary: Update ClaimTransaction description: Updates a specific ClaimTransaction. operationId: UpdateClaimTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimTransactionKey in: path description: ClaimTransaction Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimTransaction' text/json: schema: $ref: '#/components/schemas/ClaimTransaction' application/*+json: schema: $ref: '#/components/schemas/ClaimTransaction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimTransactionVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimTransactionVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimTransactionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Transactions summary: Delete ClaimTransaction description: Deletes an ClaimTransaction operationId: DeleteClaimTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimTransactionKey in: path description: ClaimTransaction Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batches/{batchNumber}/claims/{batchClaim}/transactions-batch': put: tags: - Claim Transactions summary: Create or Update Batch ClaimTransaction description: 'Create or Update multiple ClaimTransaction at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimTransaction' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimTransaction' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimTransaction' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-types: get: tags: - Claim Types summary: List ClaimType description: Lists all ClaimTypes operationId: ListClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-types/{claimType}': get: tags: - Claim Types summary: Get ClaimType description: Gets ClaimType operationId: GetClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimType in: path description: Claim Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-value-codes: post: tags: - Claim Value Codes summary: Create ClaimValueCode description: Creates a new ClaimValueCode operationId: CreateClaimValueCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimValueCode' text/json: schema: $ref: '#/components/schemas/ClaimValueCode' application/*+json: schema: $ref: '#/components/schemas/ClaimValueCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimValueCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimValueCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimValueCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Claim Value Codes summary: List ClaimValueCode description: Lists all ClaimValueCode operationId: ListClaimValueCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimValueCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimValueCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimValueCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-value-codes/{valueCode}': get: tags: - Claim Value Codes summary: Get ClaimValueCode description: Gets ClaimValueCode operationId: GetClaimValueCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: valueCode in: path description: Value Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimValueCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimValueCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimValueCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Claim Value Codes summary: Update ClaimValueCode description: Updates a specific ClaimValueCode. operationId: UpdateClaimValueCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: valueCode in: path description: Value Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimValueCode' text/json: schema: $ref: '#/components/schemas/ClaimValueCode' application/*+json: schema: $ref: '#/components/schemas/ClaimValueCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClaimValueCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ClaimValueCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ClaimValueCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Claim Value Codes summary: Delete ClaimValueCode description: Deletes an ClaimValueCode operationId: DeleteClaimValueCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: valueCode in: path description: Value Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-value-codes-batch: put: tags: - Claim Value Codes summary: Create or Update Batch ClaimValueCode description: 'Create or Update multiple ClaimValueCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClaimValueCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClaimValueCode' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimValueCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/ClaimValueCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /classes: post: tags: - Classes summary: Create Class description: Creates a new Class operationId: CreateClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Class' text/json: schema: $ref: '#/components/schemas/Class' application/*+json: schema: $ref: '#/components/schemas/Class' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClassVBAResponse' application/json: schema: $ref: '#/components/schemas/ClassVBAResponse' text/json: schema: $ref: '#/components/schemas/ClassVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Classes summary: List Class description: Lists all Class operationId: ListClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClassListVBAResponse' application/json: schema: $ref: '#/components/schemas/ClassListVBAResponse' text/json: schema: $ref: '#/components/schemas/ClassListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/classes/{classCode}': get: tags: - Classes summary: Get Class description: Gets Class operationId: GetClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: classCode in: path description: Class Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClassVBAResponse' application/json: schema: $ref: '#/components/schemas/ClassVBAResponse' text/json: schema: $ref: '#/components/schemas/ClassVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Classes summary: Update Class description: Updates a specific Class. operationId: UpdateClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: classCode in: path description: Class Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Class' text/json: schema: $ref: '#/components/schemas/Class' application/*+json: schema: $ref: '#/components/schemas/Class' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClassVBAResponse' application/json: schema: $ref: '#/components/schemas/ClassVBAResponse' text/json: schema: $ref: '#/components/schemas/ClassVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Classes summary: Delete Class description: Deletes an Class operationId: DeleteClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: classCode in: path description: Class Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /classes-batch: put: tags: - Classes summary: Create or Update Batch Class description: 'Create or Update multiple Class at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Class' text/json: schema: type: array items: $ref: '#/components/schemas/Class' application/*+json: schema: type: array items: $ref: '#/components/schemas/Class' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /clia-certificates: post: tags: - CLIA Certificate summary: Create CLIACertificate description: Creates a new CLIACertificate operationId: CreateCLIACertificate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CLIACertificate' text/json: schema: $ref: '#/components/schemas/CLIACertificate' application/*+json: schema: $ref: '#/components/schemas/CLIACertificate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CLIACertificateVBAResponse' application/json: schema: $ref: '#/components/schemas/CLIACertificateVBAResponse' text/json: schema: $ref: '#/components/schemas/CLIACertificateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - CLIA Certificate summary: List CLIACertificate description: 'Lists all CLIACertificate given a specific ' operationId: ListCLIACertificates parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CLIACertificateListVBAResponse' application/json: schema: $ref: '#/components/schemas/CLIACertificateListVBAResponse' text/json: schema: $ref: '#/components/schemas/CLIACertificateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/clia-certificates/{certificateId}': get: tags: - CLIA Certificate summary: Get CLIACertificate description: Gets CLIACertificate operationId: GetCLIACertificate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: certificateId in: path description: Certificate ID required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CLIACertificateVBAResponse' application/json: schema: $ref: '#/components/schemas/CLIACertificateVBAResponse' text/json: schema: $ref: '#/components/schemas/CLIACertificateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - CLIA Certificate summary: Update CLIACertificate description: Updates a specific CLIACertificate. operationId: UpdateCLIACertificate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: certificateId in: path description: Certificate ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CLIACertificate' text/json: schema: $ref: '#/components/schemas/CLIACertificate' application/*+json: schema: $ref: '#/components/schemas/CLIACertificate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CLIACertificateVBAResponse' application/json: schema: $ref: '#/components/schemas/CLIACertificateVBAResponse' text/json: schema: $ref: '#/components/schemas/CLIACertificateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - CLIA Certificate summary: Delete CLIACertificate description: Deletes an CLIACertificate operationId: DeleteCLIACertificate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: certificateId in: path description: Certificate ID required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /clia-certificates-batch: put: tags: - CLIA Certificate summary: Create or Update Batch CLIACertificate description: 'Create or Update multiple CLIACertificate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCLIACertificate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CLIACertificate' text/json: schema: type: array items: $ref: '#/components/schemas/CLIACertificate' application/*+json: schema: type: array items: $ref: '#/components/schemas/CLIACertificate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/clia-certificates/{certificateID}/procedure-codes': post: tags: - CLIA Certificate Procedure Codes summary: Create CLIACertificateProcedureCode description: Creates a new CLIACertificateProcedureCode operationId: CreateCLIACertificateProcedureCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: certificateID in: path description: Certificate ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCode' text/json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCode' application/*+json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CLIACertificateProcedureCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - CLIA Certificate Procedure Codes summary: List CLIACertificateProcedureCode description: Lists all CLIACertificateProcedureCode for the given certificateID operationId: ListCLIACertificateProcedureCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: certificateID in: path description: Certificate ID required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CLIACertificateProcedureCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/clia-certificates/{certificateID}/procedure-codes/{procedureCode}': get: tags: - CLIA Certificate Procedure Codes summary: Get CLIACertificateProcedureCode description: Gets CLIACertificateProcedureCode operationId: GetCLIACertificateProcedureCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: certificateID in: path description: Certificate ID required: true schema: type: integer format: int32 - name: procedureCode in: path description: Procedure Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CLIACertificateProcedureCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - CLIA Certificate Procedure Codes summary: Update CLIACertificateProcedureCode description: Updates a specific CLIACertificateProcedureCode. operationId: UpdateCLIACertificateProcedureCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: certificateID in: path description: Certificate ID required: true schema: type: integer format: int32 - name: procedureCode in: path description: Procedure Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCode' text/json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCode' application/*+json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CLIACertificateProcedureCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CLIACertificateProcedureCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - CLIA Certificate Procedure Codes summary: Delete CLIACertificateProcedureCode description: Deletes an CLIACertificateProcedureCode operationId: DeleteCLIACertificateProcedureCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: certificateID in: path description: Certificate ID required: true schema: type: integer format: int32 - name: procedureCode in: path description: Procedure Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/clia-certificates/{certificateID}/procedure-codes-batch': put: tags: - CLIA Certificate Procedure Codes summary: Create or Update Batch CLIACertificateProcedureCode description: 'Create or Update multiple CLIACertificateProcedureCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCLIACertificateProcedureCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: certificateID in: path description: Certificate ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CLIACertificateProcedureCode' text/json: schema: type: array items: $ref: '#/components/schemas/CLIACertificateProcedureCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/CLIACertificateProcedureCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/clia-certificates': post: tags: - ' Provider CLIA Certificates' summary: Create CLIACertificateProvider description: Creates a new CLIACertificateProvider operationId: CreateCLIACertificateProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CLIACertificateProvider' text/json: schema: $ref: '#/components/schemas/CLIACertificateProvider' application/*+json: schema: $ref: '#/components/schemas/CLIACertificateProvider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CLIACertificateProviderVBAResponse' application/json: schema: $ref: '#/components/schemas/CLIACertificateProviderVBAResponse' text/json: schema: $ref: '#/components/schemas/CLIACertificateProviderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - ' Provider CLIA Certificates' summary: List CLIACertificateProvider description: Lists all CLIACertificateProvider for the given providerID operationId: ListCLIACertificateProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CLIACertificateProviderListVBAResponse' application/json: schema: $ref: '#/components/schemas/CLIACertificateProviderListVBAResponse' text/json: schema: $ref: '#/components/schemas/CLIACertificateProviderListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/clia-certificates/{certificateID}/{effectiveDate}': get: tags: - ' Provider CLIA Certificates' summary: Get CLIACertificateProvider description: Gets CLIACertificateProvider operationId: GetCLIACertificateProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: certificateID in: path description: Certificate ID required: true schema: type: integer format: int32 - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CLIACertificateProviderVBAResponse' application/json: schema: $ref: '#/components/schemas/CLIACertificateProviderVBAResponse' text/json: schema: $ref: '#/components/schemas/CLIACertificateProviderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - ' Provider CLIA Certificates' summary: Update CLIACertificateProvider description: Updates a specific CLIACertificateProvider. operationId: UpdateCLIACertificateProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: certificateID in: path description: Certificate ID required: true schema: type: integer format: int32 - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/CLIACertificateProvider' text/json: schema: $ref: '#/components/schemas/CLIACertificateProvider' application/*+json: schema: $ref: '#/components/schemas/CLIACertificateProvider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CLIACertificateProviderVBAResponse' application/json: schema: $ref: '#/components/schemas/CLIACertificateProviderVBAResponse' text/json: schema: $ref: '#/components/schemas/CLIACertificateProviderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - ' Provider CLIA Certificates' summary: Delete CLIACertificateProvider description: Deletes an CLIACertificateProvider operationId: DeleteCLIACertificateProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: certificateID in: path description: Certificate ID required: true schema: type: integer format: int32 - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/clia-certificates-batch': put: tags: - ' Provider CLIA Certificates' summary: Create or Update Batch CLIACertificateProvider description: 'Create or Update multiple CLIACertificateProvider at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCLIACertificateProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CLIACertificateProvider' text/json: schema: type: array items: $ref: '#/components/schemas/CLIACertificateProvider' application/*+json: schema: type: array items: $ref: '#/components/schemas/CLIACertificateProvider' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /colleges: post: tags: - Colleges summary: Create College description: Creates a new College operationId: CreateCollege parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/College' text/json: schema: $ref: '#/components/schemas/College' application/*+json: schema: $ref: '#/components/schemas/College' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CollegeVBAResponse' application/json: schema: $ref: '#/components/schemas/CollegeVBAResponse' text/json: schema: $ref: '#/components/schemas/CollegeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Colleges summary: List College description: Lists all College operationId: ListCollege parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CollegeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CollegeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CollegeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/colleges/{collegeKey}': get: tags: - Colleges summary: Get College description: Gets College operationId: GetCollege parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: collegeKey in: path description: College Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CollegeVBAResponse' application/json: schema: $ref: '#/components/schemas/CollegeVBAResponse' text/json: schema: $ref: '#/components/schemas/CollegeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Colleges summary: Update College description: Updates a specific College. operationId: UpdateCollege parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: collegeKey in: path description: College Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/College' text/json: schema: $ref: '#/components/schemas/College' application/*+json: schema: $ref: '#/components/schemas/College' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CollegeVBAResponse' application/json: schema: $ref: '#/components/schemas/CollegeVBAResponse' text/json: schema: $ref: '#/components/schemas/CollegeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Colleges summary: Delete College description: Deletes an College operationId: DeleteCollege parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: collegeKey in: path description: College Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /colleges-batch: put: tags: - Colleges summary: Create or Update Batch College description: 'Create or Update multiple College at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCollege parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/College' text/json: schema: type: array items: $ref: '#/components/schemas/College' application/*+json: schema: type: array items: $ref: '#/components/schemas/College' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /college-types: post: tags: - College Types summary: Create CollegeType description: Creates a new CollegeType operationId: CreateCollegeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CollegeType' text/json: schema: $ref: '#/components/schemas/CollegeType' application/*+json: schema: $ref: '#/components/schemas/CollegeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CollegeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CollegeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CollegeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - College Types summary: List CollegeType description: Lists all CollegeType operationId: ListCollegeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CollegeTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CollegeTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CollegeTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/college-types/{collegeType}': get: tags: - College Types summary: Get CollegeType description: Gets CollegeType operationId: GetCollegeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: collegeType in: path description: College Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CollegeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CollegeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CollegeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - College Types summary: Update CollegeType description: Updates a specific CollegeType. operationId: UpdateCollegeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: collegeType in: path description: College Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CollegeType' text/json: schema: $ref: '#/components/schemas/CollegeType' application/*+json: schema: $ref: '#/components/schemas/CollegeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CollegeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CollegeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CollegeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - College Types summary: Delete CollegeType description: Deletes an CollegeType operationId: DeleteCollegeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: collegeType in: path description: College Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /college-types-batch: put: tags: - College Types summary: Create or Update Batch CollegeType description: 'Create or Update multiple CollegeType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCollegeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CollegeType' text/json: schema: type: array items: $ref: '#/components/schemas/CollegeType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CollegeType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-transactions/{commTransKey}/commissions': post: tags: - Commissions summary: Create Commission description: Creates a new Commission operationId: CreateCommission parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commTransKey in: path description: CommissionTransaction Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Commission' text/json: schema: $ref: '#/components/schemas/Commission' application/*+json: schema: $ref: '#/components/schemas/Commission' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commissions summary: List Commission description: Lists all Commission for the given commTransKey operationId: ListCommission parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commTransKey in: path description: CommissionTransaction Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-generate: post: tags: - Commissions - Adv. Commission summary: Commission Generate description: Generates Commission records and attaches those to a new Commission Transaction based on entered criteria. operationId: CommissionGenerate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /unassigned-commissions: get: tags: - Commissions summary: List Unassigned Commission description: Lists all Commissions that are not assigned to a Commission Transaction. operationId: ListUnassignedCommission parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-transactions/{commTransKey}/commissions/{commKey}': get: tags: - Commissions summary: Get Commission description: Gets Commission operationId: GetCommission parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commTransKey in: path description: CommissionTransaction Key required: true schema: type: integer format: int32 - name: commKey in: path description: Commission Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commissions summary: Update Commission description: Updates a specific Commission. operationId: UpdateCommission parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commTransKey in: path description: CommissionTransaction Key required: true schema: type: integer format: int32 - name: commKey in: path description: Commission Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Commission' text/json: schema: $ref: '#/components/schemas/Commission' application/*+json: schema: $ref: '#/components/schemas/Commission' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commissions summary: Delete Commission description: Deletes an Commission operationId: DeleteCommission parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commTransKey in: path description: CommissionTransaction Key required: true schema: type: integer format: int32 - name: commKey in: path description: Commission Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-transactions/{commTransKey}/commissions-batch': put: tags: - Commissions summary: Create or Update Batch Commission description: 'Create or Update multiple Commission at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommission parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commTransKey in: path description: CommissionTransaction Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Commission' text/json: schema: type: array items: $ref: '#/components/schemas/Commission' application/*+json: schema: type: array items: $ref: '#/components/schemas/Commission' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-activities: post: tags: - Commission Activity summary: Create CommissionActivity description: Creates a new CommissionActivity operationId: CreateCommissionActivity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionActivity' text/json: schema: $ref: '#/components/schemas/CommissionActivity' application/*+json: schema: $ref: '#/components/schemas/CommissionActivity' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Activity summary: List CommissionActivity description: Lists all CommissionActivity operationId: ListCommissionActivity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionActivityListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionActivityListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionActivityListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-activities/{commActivityKey}': get: tags: - Commission Activity summary: Get CommissionActivity description: Gets CommissionActivity operationId: GetCommissionActivity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commActivityKey in: path description: CommissionActivity Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Activity summary: Update CommissionActivity description: Updates a specific CommissionActivity. operationId: UpdateCommissionActivity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commActivityKey in: path description: CommissionActivity Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionActivity' text/json: schema: $ref: '#/components/schemas/CommissionActivity' application/*+json: schema: $ref: '#/components/schemas/CommissionActivity' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Activity summary: Delete CommissionActivity description: Deletes an CommissionActivity operationId: DeleteCommissionActivity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commActivityKey in: path description: CommissionActivity Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-activities-batch: put: tags: - Commission Activity summary: Create or Update Batch CommissionActivity description: 'Create or Update multiple CommissionActivity at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionActivity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionActivity' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionActivity' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionActivity' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-adjustments: post: tags: - Commission Adjustments summary: Create CommissionAdjustment description: Creates a new CommissionAdjustment operationId: CreateCommissionAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAdjustment' text/json: schema: $ref: '#/components/schemas/CommissionAdjustment' application/*+json: schema: $ref: '#/components/schemas/CommissionAdjustment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAdjustmentVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Adjustments summary: List CommissionAdjustment description: Lists all CommissionAdjustment operationId: ListCommissionAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAdjustmentListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /unassigned-commission-adjustments: get: tags: - Unassigned Commission Adjustments summary: List Unassigned CommissionAdjustment description: Lists all CommissionAdjustment that have no Commission Transaction. operationId: ListUnassignedCommissionAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAdjustmentListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-adjustments/{commAdjKey}': get: tags: - Commission Adjustments summary: Get CommissionAdjustment description: Gets CommissionAdjustment operationId: GetCommissionAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAdjKey in: path description: CommissionAdjustment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAdjustmentVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Adjustments summary: Update CommissionAdjustment description: Updates a specific CommissionAdjustment. operationId: UpdateCommissionAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAdjKey in: path description: CommissionAdjustment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAdjustment' text/json: schema: $ref: '#/components/schemas/CommissionAdjustment' application/*+json: schema: $ref: '#/components/schemas/CommissionAdjustment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAdjustmentVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Adjustments summary: Delete CommissionAdjustment description: Deletes an CommissionAdjustment operationId: DeleteCommissionAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAdjKey in: path description: CommissionAdjustment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-adjustments-batch: put: tags: - Commission Adjustments summary: Create or Update Batch CommissionAdjustment description: 'Create or Update multiple CommissionAdjustment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionAdjustment' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionAdjustment' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionAdjustment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-adjustment-reasons: post: tags: - Commission Adjustment Reasons summary: Create CommissionAdjustmentReason description: Creates a new CommissionAdjustmentReason operationId: CreateCommissionAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentReason' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentReason' application/*+json: schema: $ref: '#/components/schemas/CommissionAdjustmentReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAdjustmentReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Adjustment Reasons summary: List CommissionAdjustmentReason description: Lists all CommissionAdjustmentReason operationId: ListCommissionAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAdjustmentReasonListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentReasonListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentReasonListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-adjustment-reasons/{commAdjReason}': get: tags: - Commission Adjustment Reasons summary: Get CommissionAdjustmentReason description: Gets CommissionAdjustmentReason operationId: GetCommissionAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAdjReason in: path description: Commission Adjustment Reason required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAdjustmentReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Adjustment Reasons summary: Update CommissionAdjustmentReason description: Updates a specific CommissionAdjustmentReason. operationId: UpdateCommissionAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAdjReason in: path description: Commission Adjustment Reason required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentReason' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentReason' application/*+json: schema: $ref: '#/components/schemas/CommissionAdjustmentReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAdjustmentReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Adjustment Reasons summary: Delete CommissionAdjustmentReason description: Deletes an CommissionAdjustmentReason operationId: DeleteCommissionAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAdjReason in: path description: Commission Adjustment Reason required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-adjustment-reasons-batch: put: tags: - Commission Adjustment Reasons summary: Create or Update Batch CommissionAdjustmentReason description: 'Create or Update multiple CommissionAdjustmentReason at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionAdjustmentReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionAdjustmentReason' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionAdjustmentReason' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionAdjustmentReason' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-adjustment-types: post: tags: - Commission Adjustment Types summary: Create CommissionAdjustmentType description: Creates a new CommissionAdjustmentType operationId: CreateCommissionAdjustmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentType' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentType' application/*+json: schema: $ref: '#/components/schemas/CommissionAdjustmentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAdjustmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Adjustment Types summary: List CommissionAdjustmentType description: Lists all CommissionAdjustmentType operationId: ListCommissionAdjustmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAdjustmentTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-adjustment-types/{commAdjType}': get: tags: - Commission Adjustment Types summary: Get CommissionAdjustmentType description: Gets CommissionAdjustmentType operationId: GetCommissionAdjustmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAdjType in: path description: Commission Adjustment Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAdjustmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Adjustment Types summary: Update CommissionAdjustmentType description: Updates a specific CommissionAdjustmentType. operationId: UpdateCommissionAdjustmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAdjType in: path description: Commission Adjustment Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentType' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentType' application/*+json: schema: $ref: '#/components/schemas/CommissionAdjustmentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAdjustmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAdjustmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAdjustmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Adjustment Types summary: Delete CommissionAdjustmentType description: Deletes an CommissionAdjustmentType operationId: DeleteCommissionAdjustmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAdjType in: path description: Commission Adjustment Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-adjustment-types-batch: put: tags: - Commission Adjustment Types summary: Create or Update Batch CommissionAdjustmentType description: 'Create or Update multiple CommissionAdjustmentType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionAdjustmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionAdjustmentType' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionAdjustmentType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionAdjustmentType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-agencies: post: tags: - Commission Agencies summary: Create CommissionAgency description: Creates a new CommissionAgency operationId: CreateCommissionAgency parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAgency' text/json: schema: $ref: '#/components/schemas/CommissionAgency' application/*+json: schema: $ref: '#/components/schemas/CommissionAgency' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Agencies summary: List CommissionAgency description: Lists all CommissionAgency operationId: ListCommissionAgency parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-agencies/{commAgencyKey}': get: tags: - Commission Agencies summary: Get CommissionAgency description: Gets CommissionAgency operationId: GetCommissionAgency parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAgencyKey in: path description: CommissionAgency Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Agencies summary: Update CommissionAgency description: Updates a specific CommissionAgency. operationId: UpdateCommissionAgency parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAgencyKey in: path description: CommissionAgency Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAgency' text/json: schema: $ref: '#/components/schemas/CommissionAgency' application/*+json: schema: $ref: '#/components/schemas/CommissionAgency' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Agencies summary: Delete CommissionAgency description: Deletes an CommissionAgency operationId: DeleteCommissionAgency parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAgencyKey in: path description: CommissionAgency Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-agencies-batch: put: tags: - Commission Agencies summary: Create or Update Batch CommissionAgency description: 'Create or Update multiple CommissionAgency at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionAgency parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionAgency' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionAgency' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionAgency' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-agency-reps: post: tags: - Commission Agency Reps summary: Create CommissionAgencyRep description: Creates a new CommissionAgencyRep operationId: CreateCommissionAgencyRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAgencyRep' text/json: schema: $ref: '#/components/schemas/CommissionAgencyRep' application/*+json: schema: $ref: '#/components/schemas/CommissionAgencyRep' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyRepVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyRepVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyRepVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Agency Reps summary: List Commission Agency Representatives description: 'Lists all Commission Agency Representatives for the optional Commission Agency key, with pagination.' operationId: ListCommissionAgencyRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAgencyKey in: query description: CommissionAgency Key schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyRepListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyRepListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyRepListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-agency-reps/{commAgencyRepKey}': get: tags: - Commission Agency Reps summary: Get CommissionAgencyRep description: Gets CommissionAgencyRep operationId: GetCommissionAgencyRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAgencyRepKey in: path description: CommissionAgencyRep Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyRepVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyRepVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyRepVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Agency Reps summary: Update CommissionAgencyRep description: Updates a specific CommissionAgencyRep. operationId: UpdateCommissionAgencyRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAgencyRepKey in: path description: CommissionAgencyRep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAgencyRep' text/json: schema: $ref: '#/components/schemas/CommissionAgencyRep' application/*+json: schema: $ref: '#/components/schemas/CommissionAgencyRep' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyRepVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyRepVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyRepVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Agency Reps summary: Delete CommissionAgencyRep description: Deletes an CommissionAgencyRep operationId: DeleteCommissionAgencyRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAgencyRepKey in: path description: CommissionAgencyRep Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-agency-reps-batch: put: tags: - Commission Agency Reps summary: Create or Update Batch CommissionAgencyRep description: 'Create or Update multiple CommissionAgencyRep at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionAgencyRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionAgencyRep' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionAgencyRep' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionAgencyRep' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-agency-rep-rates: post: tags: - Commission Agency Rep Rates summary: Create CommissionAgencyRepRate description: Creates a new CommissionAgencyRepRate operationId: CreateCommissionAgencyRepRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAgencyRepRate' text/json: schema: $ref: '#/components/schemas/CommissionAgencyRepRate' application/*+json: schema: $ref: '#/components/schemas/CommissionAgencyRepRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyRepRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyRepRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyRepRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Agency Rep Rates summary: Delete CommissionAgencyRepRate by Agent description: Deletes an CommissionAgencyRepRate by Agent operationId: DeleteCommissionAgencyRepRateByAgent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commissionAgencyRepKey in: query description: CommissionAgencyRep Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rates/{commRateKey}/commission-agency-rep-rates': get: tags: - Commission Agency Rep Rates summary: List CommissionAgencyRepRate description: Lists all CommissionAgencyRepRate for the given commRateKey operationId: ListCommissionAgencyRepRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyRepRateListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyRepRateListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyRepRateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-agency-rep-rates/{commAgencyRepRateKey}': get: tags: - Commission Agency Rep Rates summary: Get CommissionAgencyRepRate description: Gets CommissionAgencyRepRate operationId: GetCommissionAgencyRepRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAgencyRepRateKey in: path description: CommissionAgencyRepRate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyRepRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyRepRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyRepRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Agency Rep Rates summary: Update CommissionAgencyRepRate description: Updates a specific CommissionAgencyRepRate. operationId: UpdateCommissionAgencyRepRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAgencyRepRateKey in: path description: CommissionAgencyRepRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAgencyRepRate' text/json: schema: $ref: '#/components/schemas/CommissionAgencyRepRate' application/*+json: schema: $ref: '#/components/schemas/CommissionAgencyRepRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyRepRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyRepRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyRepRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Agency Rep Rates summary: Delete CommissionAgencyRepRate description: Deletes an CommissionAgencyRepRate operationId: DeleteCommissionAgencyRepRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commAgencyRepRateKey in: path description: CommissionAgencyRepRate Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rates/{commRateKey}/commission-agency-rep-rates-batch': put: tags: - Commission Agency Rep Rates summary: Create or Update Batch CommissionAgencyRepRate description: 'Create or Update multiple CommissionAgencyRepRate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionAgencyRepRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionAgencyRepRate' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionAgencyRepRate' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionAgencyRepRate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-agency-types: post: tags: - Commission Agency Types summary: Create CommissionAgencyType description: Creates a new CommissionAgencyType operationId: CreateCommissionAgencyType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAgencyType' text/json: schema: $ref: '#/components/schemas/CommissionAgencyType' application/*+json: schema: $ref: '#/components/schemas/CommissionAgencyType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Agency Types summary: List CommissionAgencyType description: Lists all CommissionAgencyType operationId: ListCommissionAgencyType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-agency-types/{agencyType}': get: tags: - Commission Agency Types summary: Get CommissionAgencyType description: Gets CommissionAgencyType operationId: GetCommissionAgencyType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: agencyType in: path description: Agency Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Agency Types summary: Update CommissionAgencyType description: Updates a specific CommissionAgencyType. operationId: UpdateCommissionAgencyType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: agencyType in: path description: Agency Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAgencyType' text/json: schema: $ref: '#/components/schemas/CommissionAgencyType' application/*+json: schema: $ref: '#/components/schemas/CommissionAgencyType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAgencyTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAgencyTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAgencyTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Agency Types summary: Delete CommissionAgencyType description: Deletes an CommissionAgencyType operationId: DeleteCommissionAgencyType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: agencyType in: path description: Agency Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-agency-types-batch: put: tags: - Commission Agency Types summary: Create or Update Batch CommissionAgencyType description: 'Create or Update multiple CommissionAgencyType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionAgencyType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionAgencyType' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionAgencyType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionAgencyType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-appointment-types: post: tags: - Commission Appointment Types summary: Create CommissionAppointmentType description: Creates a new CommissionAppointmentType operationId: CreateCommissionAppointmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAppointmentType' text/json: schema: $ref: '#/components/schemas/CommissionAppointmentType' application/*+json: schema: $ref: '#/components/schemas/CommissionAppointmentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAppointmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAppointmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAppointmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Appointment Types summary: List CommissionAppointmentType description: Lists all CommissionAppointmentType operationId: ListCommissionAppointmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAppointmentTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAppointmentTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAppointmentTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-appointment-types/{appointmentType}': get: tags: - Commission Appointment Types summary: Get CommissionAppointmentType description: Gets CommissionAppointmentType operationId: GetCommissionAppointmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: appointmentType in: path description: Appointment Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAppointmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAppointmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAppointmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Appointment Types summary: Update CommissionAppointmentType description: Updates a specific CommissionAppointmentType. operationId: UpdateCommissionAppointmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: appointmentType in: path description: Appointment Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionAppointmentType' text/json: schema: $ref: '#/components/schemas/CommissionAppointmentType' application/*+json: schema: $ref: '#/components/schemas/CommissionAppointmentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionAppointmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionAppointmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionAppointmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Appointment Types summary: Delete CommissionAppointmentType description: Deletes an CommissionAppointmentType operationId: DeleteCommissionAppointmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: appointmentType in: path description: Appointment Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-appointment-types-batch: put: tags: - Commission Appointment Types summary: Create or Update Batch CommissionAppointmentType description: 'Create or Update multiple CommissionAppointmentType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionAppointmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionAppointmentType' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionAppointmentType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionAppointmentType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-basis: post: tags: - Commission Basis summary: Create CommissionBasis description: Creates a new CommissionBasis operationId: CreateCommissionBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionBasis' text/json: schema: $ref: '#/components/schemas/CommissionBasis' application/*+json: schema: $ref: '#/components/schemas/CommissionBasis' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionBasisVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionBasisVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionBasisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Basis summary: List CommissionBasis description: Lists all CommissionBasis operationId: ListCommissionBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionBasisListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionBasisListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionBasisListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-basis/{commBasis}': get: tags: - Commission Basis summary: Get CommissionBasis description: Gets CommissionBasis operationId: GetCommissionBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commBasis in: path description: Commission Basis required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionBasisVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionBasisVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionBasisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Basis summary: Update CommissionBasis description: Updates a specific CommissionBasis. operationId: UpdateCommissionBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commBasis in: path description: Commission Basis required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionBasis' text/json: schema: $ref: '#/components/schemas/CommissionBasis' application/*+json: schema: $ref: '#/components/schemas/CommissionBasis' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionBasisVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionBasisVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionBasisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Basis summary: Delete CommissionBasis description: Deletes an CommissionBasis operationId: DeleteCommissionBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commBasis in: path description: Commission Basis required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-basis-batch: put: tags: - Commission Basis summary: Create or Update Batch CommissionBasis description: 'Create or Update multiple CommissionBasis at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionBasis' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionBasis' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionBasis' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-categories: post: tags: - Commission Categories summary: Create CommissionCategory description: Creates a new CommissionCategory operationId: CreateCommissionCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionCategory' text/json: schema: $ref: '#/components/schemas/CommissionCategory' application/*+json: schema: $ref: '#/components/schemas/CommissionCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Categories summary: List CommissionCategory description: Lists all CommissionCategory operationId: ListCommissionCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-categories/{commCategory}': get: tags: - Commission Categories summary: Get CommissionCategory description: Gets CommissionCategory operationId: GetCommissionCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commCategory in: path description: Commission Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Categories summary: Update CommissionCategory description: Updates a specific CommissionCategory. operationId: UpdateCommissionCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commCategory in: path description: Commission Category required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionCategory' text/json: schema: $ref: '#/components/schemas/CommissionCategory' application/*+json: schema: $ref: '#/components/schemas/CommissionCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Categories summary: Delete CommissionCategory description: Deletes an CommissionCategory operationId: DeleteCommissionCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commCategory in: path description: Commission Category required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-categories-batch: put: tags: - Commission Categories summary: Create or Update Batch CommissionCategory description: 'Create or Update multiple CommissionCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionCategory' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-cycles: post: tags: - Commission Cycles summary: Create CommissionCycle description: Creates a new CommissionCycle operationId: CreateCommissionCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionCycle' text/json: schema: $ref: '#/components/schemas/CommissionCycle' application/*+json: schema: $ref: '#/components/schemas/CommissionCycle' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionCycleVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionCycleVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionCycleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Cycles summary: List CommissionCycle description: Lists all CommissionCycle operationId: ListCommissionCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionCycleListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionCycleListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionCycleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-cycles/{commCycle}': get: tags: - Commission Cycles summary: Get CommissionCycle description: Gets CommissionCycle operationId: GetCommissionCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commCycle in: path description: Commission Cycle required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionCycleVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionCycleVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionCycleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Cycles summary: Update CommissionCycle description: Updates a specific CommissionCycle. operationId: UpdateCommissionCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commCycle in: path description: Commission Cycle required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionCycle' text/json: schema: $ref: '#/components/schemas/CommissionCycle' application/*+json: schema: $ref: '#/components/schemas/CommissionCycle' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionCycleVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionCycleVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionCycleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Cycles summary: Delete CommissionCycle description: Deletes an CommissionCycle operationId: DeleteCommissionCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commCycle in: path description: Commission Cycle required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-cycles-batch: put: tags: - Commission Cycles summary: Create or Update Batch CommissionCycle description: 'Create or Update multiple CommissionCycle at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionCycle' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionCycle' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionCycle' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-activities-undo/{commActivityKey}': post: tags: - Commission Activity - Adv. Commission summary: Undo CommissionActivity description: Undo Commissions by Commission Activity operationId: UndoCommissionActivity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commActivityKey in: path description: CommissionActivity Key required: true schema: type: integer format: int32 - name: undoUser in: query description: Undo User schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/commission-activities-undo-by-rep/{commActivityKey}': post: tags: - Commission Activity - Adv. Commission summary: Undo CommissionActivity by Rep or Group description: Undo Commissions by Commission Activity based on the passed in optional parameters of commAgencyRep or groupId. Group undo takes priory if passed in with a Rep Key. operationId: UndoByRepCommissionActivity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commActivityKey in: path description: CommissionActivity Key required: true schema: type: integer format: int32 - name: undoUser in: query description: Undo User schema: type: string - name: groupId in: query description: Group ID schema: type: string - name: commAgencyRepKey in: query description: Agency Rep Key schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionActivityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /commission-generate-checks: post: tags: - Adv. Commission summary: Generate Commission Checks description: Send in a list of Commission Checks to be generated. operationId: CommissionGenerateCheck parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/COMMCHECKS' text/json: schema: type: array items: $ref: '#/components/schemas/COMMCHECKS' application/*+json: schema: type: array items: $ref: '#/components/schemas/COMMCHECKS' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32VBAResponse' application/json: schema: $ref: '#/components/schemas/Int32VBAResponse' text/json: schema: $ref: '#/components/schemas/Int32VBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /commission-license-types: post: tags: - Commission License Types summary: Create CommissionLicenseType description: Creates a new CommissionLicenseType operationId: CreateCommissionLicenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionLicenseType' text/json: schema: $ref: '#/components/schemas/CommissionLicenseType' application/*+json: schema: $ref: '#/components/schemas/CommissionLicenseType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionLicenseTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionLicenseTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionLicenseTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission License Types summary: List CommissionLicenseType description: Lists all CommissionLicenseType operationId: ListCommissionLicenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionLicenseTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionLicenseTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionLicenseTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-license-types/{licenseType}': get: tags: - Commission License Types summary: Get CommissionLicenseType description: Gets CommissionLicenseType operationId: GetCommissionLicenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: licenseType in: path description: License Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionLicenseTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionLicenseTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionLicenseTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission License Types summary: Update CommissionLicenseType description: Updates a specific CommissionLicenseType. operationId: UpdateCommissionLicenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: licenseType in: path description: License Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionLicenseType' text/json: schema: $ref: '#/components/schemas/CommissionLicenseType' application/*+json: schema: $ref: '#/components/schemas/CommissionLicenseType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionLicenseTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionLicenseTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionLicenseTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission License Types summary: Delete CommissionLicenseType description: Deletes an CommissionLicenseType operationId: DeleteCommissionLicenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: licenseType in: path description: License Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-license-types-batch: put: tags: - Commission License Types summary: Create or Update Batch CommissionLicenseType description: 'Create or Update multiple CommissionLicenseType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionLicenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionLicenseType' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionLicenseType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionLicenseType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-activities/{commActivityKey}/commission-parameters': post: tags: - Commission Activity Parameters summary: Create CommissionParameter description: Creates a new CommissionParameter operationId: CreateCommissionParameter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commActivityKey in: path description: CommissionActivity Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionParameter' text/json: schema: $ref: '#/components/schemas/CommissionParameter' application/*+json: schema: $ref: '#/components/schemas/CommissionParameter' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionParameterVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionParameterVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionParameterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Activity Parameters summary: List CommissionParameter description: Lists all CommissionParameter for the given commActivityKey operationId: ListCommissionParameter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commActivityKey in: path description: CommissionActivity Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionParameterListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionParameterListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionParameterListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-activities/{commActivityKey}/commission-parameters/{commParameterKey}': get: tags: - Commission Activity Parameters summary: Get CommissionParameter description: Gets CommissionParameter operationId: GetCommissionParameter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commActivityKey in: path description: CommissionActivity Key required: true schema: type: integer format: int32 - name: commParameterKey in: path description: CommissionParameter Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionParameterVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionParameterVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionParameterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Activity Parameters summary: Update CommissionParameter description: Updates a specific CommissionParameter. operationId: UpdateCommissionParameter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commActivityKey in: path description: CommissionActivity Key required: true schema: type: integer format: int32 - name: commParameterKey in: path description: CommissionParameter Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionParameter' text/json: schema: $ref: '#/components/schemas/CommissionParameter' application/*+json: schema: $ref: '#/components/schemas/CommissionParameter' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionParameterVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionParameterVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionParameterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Activity Parameters summary: Delete CommissionParameter description: Deletes an CommissionParameter operationId: DeleteCommissionParameter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commActivityKey in: path description: CommissionActivity Key required: true schema: type: integer format: int32 - name: commParameterKey in: path description: CommissionParameter Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-activities/{commActivityKey}/commission-parameters-batch': put: tags: - Commission Activity Parameters summary: Create or Update Batch CommissionParameter description: 'Create or Update multiple CommissionParameter at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionParameter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commActivityKey in: path description: CommissionActivity Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionParameter' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionParameter' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionParameter' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-rates: post: tags: - Commission Rates summary: Create CommissionRate description: Creates a new CommissionRate operationId: CreateCommissionRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRate' text/json: schema: $ref: '#/components/schemas/CommissionRate' application/*+json: schema: $ref: '#/components/schemas/CommissionRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Rates summary: List CommissionRate description: Lists all CommissionRate operationId: ListCommissionRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rates/{commRateKey}/commission-rates-group/{groupId}': post: tags: - Commission Rates summary: Create CommissionRate from Template description: Creates a new CommissionRate from a template CommissionRate. operationId: CreateCommissionRateFromTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 - name: groupId in: path description: Group ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rate-copy/{commRateKey}': post: tags: - Commission Rates summary: Copies CommissionRate from Rate description: Creates a new CommissionRate from a given CommissionRate. operationId: CopyRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rates-cluster/{commRateCluster}/commission-rates-group/{groupId}': post: tags: - Commission Rates summary: Create CommissionRate from Rate Cluster description: Creates a new CommissionRate records from a cluster of templated rates. operationId: CreateCommissionRateFromCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateCluster in: path description: Rate Cluster required: true schema: type: string - name: groupId in: path description: Group ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-rates-nested: get: tags: - Commission Rates summary: List Commission Rates nested by Division/Plan description: 'Lists all Commission Rates for the given groupID and have it nested by Division, then by Plan.' operationId: ListCommissionRateNested parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: query description: Group ID schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateNestedListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateNestedListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateNestedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rates/{commRateKey}': get: tags: - Commission Rates summary: Get CommissionRate description: Gets CommissionRate operationId: GetCommissionRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Rates summary: Update CommissionRate description: Updates a specific CommissionRate. operationId: UpdateCommissionRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRate' text/json: schema: $ref: '#/components/schemas/CommissionRate' application/*+json: schema: $ref: '#/components/schemas/CommissionRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Rates summary: Delete CommissionRate description: Deletes an CommissionRate operationId: DeleteCommissionRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-rates-batch: put: tags: - Commission Rates summary: Create or Update Batch CommissionRate description: 'Create or Update multiple CommissionRate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionRate' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionRate' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionRate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-rate-clusters: post: tags: - Commission Rate Clusters summary: Create CommissionRateCluster description: Creates a new CommissionRateCluster operationId: CreateCommissionRateCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRateCluster' text/json: schema: $ref: '#/components/schemas/CommissionRateCluster' application/*+json: schema: $ref: '#/components/schemas/CommissionRateCluster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Rate Clusters summary: List CommissionRateCluster description: Lists all CommissionRateCluster operationId: ListCommissionRateCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateClusterListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateClusterListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rate-clusters/{rateCluster}': get: tags: - Commission Rate Clusters summary: Get CommissionRateCluster description: Gets CommissionRateCluster operationId: GetCommissionRateCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: rateCluster in: path description: Rate Cluster required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Rate Clusters summary: Update CommissionRateCluster description: Updates a specific CommissionRateCluster. operationId: UpdateCommissionRateCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: rateCluster in: path description: Rate Cluster required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRateCluster' text/json: schema: $ref: '#/components/schemas/CommissionRateCluster' application/*+json: schema: $ref: '#/components/schemas/CommissionRateCluster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Rate Clusters summary: Delete CommissionRateCluster description: Deletes an CommissionRateCluster operationId: DeleteCommissionRateCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: rateCluster in: path description: Rate Cluster required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-rate-clusters-batch: put: tags: - Commission Rate Clusters summary: Create or Update Batch CommissionRateCluster description: 'Create or Update multiple CommissionRateCluster at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionRateCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionRateCluster' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionRateCluster' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionRateCluster' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-rate-cluster-agency-reps: post: tags: - Commission Rate Cluster Agency Rep summary: Create CommissionRateClusterAgencyRep description: Creates a new CommissionRateClusterAgencyRep operationId: CreateCommissionRateClusterAgencyRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRep' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRep' application/*+json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRep' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRepVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRepVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRepVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Rate Cluster Agency Rep summary: List CommissionRateClusterAgencyRep description: Lists all CommissionRateClusterAgencyRep operationId: ListCommissionRateClusterAgencyRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRepListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRepListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRepListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rate-cluster-agency-reps/{CommissionRateClusterAgencyRep_Key}': get: tags: - Commission Rate Cluster Agency Rep summary: Get CommissionRateClusterAgencyRep description: Gets CommissionRateClusterAgencyRep operationId: GetCommissionRateClusterAgencyRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CommissionRateClusterAgencyRep_Key in: path description: CommissionRateClusterAgencyRep Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRepVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRepVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRepVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Rate Cluster Agency Rep summary: Update CommissionRateClusterAgencyRep description: Updates a specific CommissionRateClusterAgencyRep. operationId: UpdateCommissionRateClusterAgencyRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CommissionRateClusterAgencyRep_Key in: path description: CommissionRateClusterAgencyRep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRep' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRep' application/*+json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRep' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRepVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRepVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterAgencyRepVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Rate Cluster Agency Rep summary: Delete CommissionRateClusterAgencyRep description: Deletes an CommissionRateClusterAgencyRep operationId: DeleteCommissionRateClusterAgencyRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: CommissionRateClusterAgencyRep_Key in: path description: CommissionRateClusterAgencyRep Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-rate-cluster-agency-reps-batch: put: tags: - Commission Rate Cluster Agency Rep summary: Create or Update Batch CommissionRateClusterAgencyRep description: 'Create or Update multiple CommissionRateClusterAgencyRep at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionRateClusterAgencyRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionRateClusterAgencyRep' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionRateClusterAgencyRep' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionRateClusterAgencyRep' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rate-clusters/{rateCluster}/commission-rates': post: tags: - Commission Rate Cluster Rates summary: Create CommissionRateClusterRate description: Creates a new CommissionRateClusterRate operationId: CreateCommissionRateClusterRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: rateCluster in: path description: Rate Cluster required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRateClusterRate' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterRate' application/*+json: schema: $ref: '#/components/schemas/CommissionRateClusterRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateClusterRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateClusterRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Rate Cluster Rates summary: List CommissionRateClusterRate description: Lists all CommissionRateClusterRate for the given rateCluster operationId: ListCommissionRateClusterRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: rateCluster in: path description: Rate Cluster required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateClusterRateListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateClusterRateListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterRateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rate-clusters/{rateCluster}/commission-rates/{commRateKey}': get: tags: - Commission Rate Cluster Rates summary: Get CommissionRateClusterRate description: Gets CommissionRateClusterRate operationId: GetCommissionRateClusterRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: rateCluster in: path description: Rate Cluster required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateClusterRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateClusterRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Rate Cluster Rates summary: Update CommissionRateClusterRate description: Updates a specific CommissionRateClusterRate. operationId: UpdateCommissionRateClusterRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: rateCluster in: path description: Rate Cluster required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRateClusterRate' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterRate' application/*+json: schema: $ref: '#/components/schemas/CommissionRateClusterRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateClusterRateVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateClusterRateVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateClusterRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Rate Cluster Rates summary: Delete CommissionRateClusterRate description: Deletes an CommissionRateClusterRate operationId: DeleteCommissionRateClusterRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: rateCluster in: path description: Rate Cluster required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rate-clusters/{rateCluster}/commission-rates-batch': put: tags: - Commission Rate Cluster Rates summary: Create or Update Batch CommissionRateClusterRate description: 'Create or Update multiple CommissionRateClusterRate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionRateClusterRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: rateCluster in: path description: Rate Cluster required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionRateClusterRate' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionRateClusterRate' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionRateClusterRate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rates/{commRateKey}/commission-rate-subscribers/{subscriberId}': post: tags: - Commission Rate Subscribers summary: Create CommissionRateSubscriber description: Creates a new CommissionRateSubscriber operationId: CreateCommissionRateSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 - name: subscriberId in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRateSubscriber' text/json: schema: $ref: '#/components/schemas/CommissionRateSubscriber' application/*+json: schema: $ref: '#/components/schemas/CommissionRateSubscriber' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Rate Subscribers summary: Get CommissionRateSubscriber description: Gets CommissionRateSubscriber operationId: GetCommissionRateSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 - name: subscriberId in: path description: Subscriber ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Rate Subscribers summary: Update CommissionRateSubscriber description: Updates a specific CommissionRateSubscriber. operationId: UpdateCommissionRateSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 - name: subscriberId in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRateSubscriber' text/json: schema: $ref: '#/components/schemas/CommissionRateSubscriber' application/*+json: schema: $ref: '#/components/schemas/CommissionRateSubscriber' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Rate Subscribers summary: Delete CommissionRateSubscriber description: Deletes an CommissionRateSubscriber operationId: DeleteCommissionRateSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 - name: subscriberId in: path description: Subscriber ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rates/{commRateKey}/commission-rate-subscribers': get: tags: - Commission Rate Subscribers summary: List CommissionRateSubscriber description: Lists all CommissionRateSubscriber for the given commRateKey operationId: ListCommissionRateSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRateSubscriberListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRateSubscriberListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRateSubscriberListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rates/{commRateKey}/commission-rate-subscribers-batch': put: tags: - Commission Rate Subscribers summary: Create or Update Batch CommissionRateSubscriber description: 'Create or Update multiple CommissionRateSubscriber at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionRateSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionRateSubscriber' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionRateSubscriber' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionRateSubscriber' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rates/{commRateKey}/commission-rate-subscribers-match': get: tags: - Commission Rate Subscribers summary: List VBA_CommissionRateSubscriber that match provided filters description: 'Retrieves a list of VBA_CommissionRateSubscriber that match provided filters. The endpoint requires a CommissionRate Key, Group ID query parameter and an optional Division ID query parameter. By default, all records, including unassigned, are included. However, the Include Unassigned query parameter can be set to false to exclude unassigned records.' operationId: ListVBA_CommissionRateSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRateKey in: path description: CommissionRate Key required: true schema: type: integer format: int32 - name: groupID in: query description: Group ID required: true schema: type: string - name: divisionID in: query description: Division ID schema: type: string - name: includeUnassigned in: query description: Include Unassigned schema: type: boolean default: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_CommissionRateSubscriberListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_CommissionRateSubscriberListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_CommissionRateSubscriberListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-reps: post: tags: - Commission Reps summary: Create CommissionRep description: Creates a new CommissionRep operationId: CreateCommissionRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRep' text/json: schema: $ref: '#/components/schemas/CommissionRep' application/*+json: schema: $ref: '#/components/schemas/CommissionRep' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Reps summary: List CommissionRep description: Lists all CommissionRep operationId: ListCommissionRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}': get: tags: - Commission Reps summary: Get CommissionRep description: Gets CommissionRep operationId: GetCommissionRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Reps summary: Update CommissionRep description: Updates a specific CommissionRep. operationId: UpdateCommissionRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRep' text/json: schema: $ref: '#/components/schemas/CommissionRep' application/*+json: schema: $ref: '#/components/schemas/CommissionRep' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Reps summary: Delete CommissionRep description: Deletes an CommissionRep operationId: DeleteCommissionRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-reps-batch: put: tags: - Commission Reps summary: Create or Update Batch CommissionRep description: 'Create or Update multiple CommissionRep at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionRep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionRep' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionRep' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionRep' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-accounts': post: tags: - Commission Rep Accounts summary: Create CommissionRepAccount description: Creates a new CommissionRepAccount operationId: CreateCommissionRepAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRepAccount' text/json: schema: $ref: '#/components/schemas/CommissionRepAccount' application/*+json: schema: $ref: '#/components/schemas/CommissionRepAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Rep Accounts summary: List CommissionRepAccount description: Lists all CommissionRepAccount for the given commRepKey operationId: ListCommissionRepAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepAccountListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepAccountListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepAccountListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-accounts/{commRepAccountKey}': get: tags: - Commission Rep Accounts summary: Get CommissionRepAccount description: Gets CommissionRepAccount operationId: GetCommissionRepAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepAccountKey in: path description: CommissionRepAccount Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Rep Accounts summary: Update CommissionRepAccount description: Updates a specific CommissionRepAccount. operationId: UpdateCommissionRepAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepAccountKey in: path description: CommissionRepAccount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRepAccount' text/json: schema: $ref: '#/components/schemas/CommissionRepAccount' application/*+json: schema: $ref: '#/components/schemas/CommissionRepAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Rep Accounts summary: Delete CommissionRepAccount description: Deletes an CommissionRepAccount operationId: DeleteCommissionRepAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepAccountKey in: path description: CommissionRepAccount Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-accounts-batch': put: tags: - Commission Rep Accounts summary: Create or Update Batch CommissionRepAccount description: 'Create or Update multiple CommissionRepAccount at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionRepAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionRepAccount' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionRepAccount' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionRepAccount' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-appoints': post: tags: - Commission Rep Appointments summary: Create CommissionRepAppoint description: Creates a new CommissionRepAppoint operationId: CreateCommissionRepAppoint parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRepAppoint' text/json: schema: $ref: '#/components/schemas/CommissionRepAppoint' application/*+json: schema: $ref: '#/components/schemas/CommissionRepAppoint' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepAppointVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepAppointVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepAppointVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Rep Appointments summary: List CommissionRepAppoint description: Lists all CommissionRepAppoint for the given commRepKey operationId: ListCommissionRepAppoint parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepAppointListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepAppointListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepAppointListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-appoints/{commRepAppointKey}': get: tags: - Commission Rep Appointments summary: Get CommissionRepAppoint description: Gets CommissionRepAppoint operationId: GetCommissionRepAppoint parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepAppointKey in: path description: CommissionRepAppoint Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepAppointVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepAppointVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepAppointVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Rep Appointments summary: Update CommissionRepAppoint description: Updates a specific CommissionRepAppoint. operationId: UpdateCommissionRepAppoint parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepAppointKey in: path description: CommissionRepAppoint Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRepAppoint' text/json: schema: $ref: '#/components/schemas/CommissionRepAppoint' application/*+json: schema: $ref: '#/components/schemas/CommissionRepAppoint' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepAppointVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepAppointVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepAppointVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Rep Appointments summary: Delete CommissionRepAppoint description: Deletes an CommissionRepAppoint operationId: DeleteCommissionRepAppoint parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepAppointKey in: path description: CommissionRepAppoint Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-appoints-batch': put: tags: - Commission Rep Appointments summary: Create or Update Batch CommissionRepAppoint description: 'Create or Update multiple CommissionRepAppoint at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionRepAppoint parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionRepAppoint' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionRepAppoint' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionRepAppoint' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-groups': post: tags: - Commission Rep Groups summary: Create CommissionRepGroup description: Creates a new CommissionRepGroup operationId: CreateCommissionRepGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRepGroup' text/json: schema: $ref: '#/components/schemas/CommissionRepGroup' application/*+json: schema: $ref: '#/components/schemas/CommissionRepGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Rep Groups summary: List CommissionRepGroup description: Lists all CommissionRepGroup for the given commRepKey operationId: ListCommissionRepGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepGroupListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepGroupListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepGroupListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-groups/{commRepGroupKey}': get: tags: - Commission Rep Groups summary: Get CommissionRepGroup description: Gets CommissionRepGroup operationId: GetCommissionRepGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepGroupKey in: path description: CommissionRepGroup Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Rep Groups summary: Update CommissionRepGroup description: Updates a specific CommissionRepGroup. operationId: UpdateCommissionRepGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepGroupKey in: path description: CommissionRepGroup Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRepGroup' text/json: schema: $ref: '#/components/schemas/CommissionRepGroup' application/*+json: schema: $ref: '#/components/schemas/CommissionRepGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Rep Groups summary: Delete CommissionRepGroup description: Deletes an CommissionRepGroup operationId: DeleteCommissionRepGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepGroupKey in: path description: CommissionRepGroup Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-groups-batch': put: tags: - Commission Rep Groups summary: Create or Update Batch CommissionRepGroup description: 'Create or Update multiple CommissionRepGroup at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionRepGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionRepGroup' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionRepGroup' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionRepGroup' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-licenses': post: tags: - Commission Rep Licenses summary: Create CommissionRepLicense description: Creates a new CommissionRepLicense operationId: CreateCommissionRepLicense parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRepLicense' text/json: schema: $ref: '#/components/schemas/CommissionRepLicense' application/*+json: schema: $ref: '#/components/schemas/CommissionRepLicense' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepLicenseVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepLicenseVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepLicenseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Rep Licenses summary: List CommissionRepLicense description: Lists all CommissionRepLicense for the given commRepKey operationId: ListCommissionRepLicense parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepLicenseListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepLicenseListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepLicenseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-licenses/{commRepLicenseKey}': get: tags: - Commission Rep Licenses summary: Get CommissionRepLicense description: Gets CommissionRepLicense operationId: GetCommissionRepLicense parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepLicenseKey in: path description: CommissionRepLicense Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepLicenseVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepLicenseVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepLicenseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Rep Licenses summary: Update CommissionRepLicense description: Updates a specific CommissionRepLicense. operationId: UpdateCommissionRepLicense parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepLicenseKey in: path description: CommissionRepLicense Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRepLicense' text/json: schema: $ref: '#/components/schemas/CommissionRepLicense' application/*+json: schema: $ref: '#/components/schemas/CommissionRepLicense' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepLicenseVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepLicenseVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepLicenseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Rep Licenses summary: Delete CommissionRepLicense description: Deletes an CommissionRepLicense operationId: DeleteCommissionRepLicense parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepLicenseKey in: path description: CommissionRepLicense Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-licenses-batch': put: tags: - Commission Rep Licenses summary: Create or Update Batch CommissionRepLicense description: 'Create or Update multiple CommissionRepLicense at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionRepLicense parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionRepLicense' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionRepLicense' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionRepLicense' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-subscribers': post: tags: - Commission Rep Subscribers summary: Create CommissionRepSubscriber description: Creates a new CommissionRepSubscriber operationId: CreateCommissionRepSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRepSubscriber' text/json: schema: $ref: '#/components/schemas/CommissionRepSubscriber' application/*+json: schema: $ref: '#/components/schemas/CommissionRepSubscriber' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Rep Subscribers summary: List CommissionRepSubscriber description: Lists all CommissionRepSubscriber for the given commRepKey operationId: ListCommissionRepSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepSubscriberListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepSubscriberListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepSubscriberListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-subscribers/{commRepSubscriberKey}': get: tags: - Commission Rep Subscribers summary: Get CommissionRepSubscriber description: Gets CommissionRepSubscriber operationId: GetCommissionRepSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepSubscriberKey in: path description: CommissionRepSubscriber Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Rep Subscribers summary: Update CommissionRepSubscriber description: Updates a specific CommissionRepSubscriber. operationId: UpdateCommissionRepSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepSubscriberKey in: path description: CommissionRepSubscriber Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRepSubscriber' text/json: schema: $ref: '#/components/schemas/CommissionRepSubscriber' application/*+json: schema: $ref: '#/components/schemas/CommissionRepSubscriber' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Rep Subscribers summary: Delete CommissionRepSubscriber description: Deletes an CommissionRepSubscriber operationId: DeleteCommissionRepSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 - name: commRepSubscriberKey in: path description: CommissionRepSubscriber Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-reps/{commRepKey}/commission-rep-subscribers-batch': put: tags: - Commission Rep Subscribers summary: Create or Update Batch CommissionRepSubscriber description: 'Create or Update multiple CommissionRepSubscriber at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionRepSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commRepKey in: path description: CommissionRep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionRepSubscriber' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionRepSubscriber' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionRepSubscriber' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-rep-types: post: tags: - Commission Rep Types summary: Create CommissionRepType description: Creates a new CommissionRepType operationId: CreateCommissionRepType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRepType' text/json: schema: $ref: '#/components/schemas/CommissionRepType' application/*+json: schema: $ref: '#/components/schemas/CommissionRepType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Rep Types summary: List CommissionRepType description: Lists all CommissionRepType operationId: ListCommissionRepType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-rep-types/{repType}': get: tags: - Commission Rep Types summary: Get CommissionRepType description: Gets CommissionRepType operationId: GetCommissionRepType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: repType in: path description: Rep Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Rep Types summary: Update CommissionRepType description: Updates a specific CommissionRepType. operationId: UpdateCommissionRepType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: repType in: path description: Rep Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionRepType' text/json: schema: $ref: '#/components/schemas/CommissionRepType' application/*+json: schema: $ref: '#/components/schemas/CommissionRepType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionRepTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionRepTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionRepTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Rep Types summary: Delete CommissionRepType description: Deletes an CommissionRepType operationId: DeleteCommissionRepType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: repType in: path description: Rep Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-rep-types-batch: put: tags: - Commission Rep Types summary: Create or Update Batch CommissionRepType description: 'Create or Update multiple CommissionRepType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionRepType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionRepType' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionRepType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionRepType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-transactions: post: tags: - Commission Transactions summary: Create CommissionTransaction description: Creates a new CommissionTransaction operationId: CreateCommissionTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionTransaction' text/json: schema: $ref: '#/components/schemas/CommissionTransaction' application/*+json: schema: $ref: '#/components/schemas/CommissionTransaction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionTransactionVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionTransactionVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionTransactionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Commission Transactions summary: List CommissionTransaction description: Lists all CommissionTransaction operationId: ListCommissionTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionTransactionListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionTransactionListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionTransactionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/commission-transactions/{commTransKey}': get: tags: - Commission Transactions summary: Get CommissionTransaction description: Gets CommissionTransaction operationId: GetCommissionTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commTransKey in: path description: CommissionTransaction Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionTransactionVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionTransactionVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionTransactionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Commission Transactions summary: Update CommissionTransaction description: Updates a specific CommissionTransaction. operationId: UpdateCommissionTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commTransKey in: path description: CommissionTransaction Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CommissionTransaction' text/json: schema: $ref: '#/components/schemas/CommissionTransaction' application/*+json: schema: $ref: '#/components/schemas/CommissionTransaction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommissionTransactionVBAResponse' application/json: schema: $ref: '#/components/schemas/CommissionTransactionVBAResponse' text/json: schema: $ref: '#/components/schemas/CommissionTransactionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Commission Transactions summary: Delete CommissionTransaction description: Deletes an CommissionTransaction operationId: DeleteCommissionTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: commTransKey in: path description: CommissionTransaction Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /commission-transactions-batch: put: tags: - Commission Transactions summary: Create or Update Batch CommissionTransaction description: 'Create or Update multiple CommissionTransaction at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommissionTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommissionTransaction' text/json: schema: type: array items: $ref: '#/components/schemas/CommissionTransaction' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommissionTransaction' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /vba-plan-types: get: tags: - VBA Plan Types summary: List VBA Plan Types description: Lists all VBA Plan Types operationId: ListVBAPlanTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vba-plan-types/{id}': get: tags: - VBA Plan Types summary: Get VBA Plan Type description: Gets a single VBA Plan Types by ID operationId: GetVBAPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: id in: path description: ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /volume-types: get: tags: - Volume Types summary: List Volume Types description: Lists all Volume Types operationId: ListVolumeTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/volume-types/{id}': get: tags: - Volume Types summary: Get Volume Type description: Gets a single Volume Type by ID operationId: GetVolumeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: id in: path description: ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /rounding-types: get: tags: - Rounding Types summary: List Rounding Types description: Lists all Rounding Types operationId: ListRoundingTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/rounding-types/{id}': get: tags: - Rounding Types summary: Get Rounding Type description: Gets a single Rounding Type by ID operationId: GetRoundingType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: id in: path description: ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /rounding-precision: get: tags: - Rounding Precision summary: List Rounding Precisions description: Lists all Rounding Precisions operationId: ListRoundingPrecision parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/rounding-precision/{id}': get: tags: - Rounding Precision summary: Get Rounding Precision description: Gets a single Rounding Precision by ID operationId: GetRoundingPrecision parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: id in: path description: ID required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /search-operators: get: tags: - Search Operators summary: List Search Operators description: Lists all Search Operators operationId: ListSearchOperators parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/search-operators/{id}': get: tags: - Search Operators summary: Get Search Operator description: Gets a single Search Operator by ID operationId: GetSearchOperator parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: id in: path description: ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /sex-codes: get: tags: - Sex Codes summary: List Sex Codes description: Lists all Sex Codes operationId: ListSexCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/sex-codes/{id}': get: tags: - Sex Codes summary: Get Sex Code description: Gets a single Sex Code by ID operationId: GetSexCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: id in: path description: ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /criteria-columns: get: tags: - Criteria Columns summary: List Criteria Columns description: Lists all Criteria Columns operationId: ListCriteriaColumns parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/criteria-columns/{id}': get: tags: - Criteria Columns summary: Get Criteria Column description: Gets a single Criteria Column by ID operationId: GetCriteriaColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: id in: path description: ID required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /employer-sizes: get: tags: - Employer Sizes summary: List Employer Sizes description: Lists all Employer Sizes operationId: ListEmployerSizes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/employer-sizes/{id}': get: tags: - Employer Sizes summary: Get Employer Size description: Gets a single Employer Size by ID operationId: GetEmployerSize parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: id in: path description: ID required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /frequency-intervals: get: tags: - Frequency Intervals summary: List Frequency Intervals description: Lists all Frequency Intervals operationId: ListFrequencyIntervals parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/frequency-intervals/{id}': get: tags: - Frequency Intervals summary: Get Frequency Interval description: Gets a single Frequency Interval by ID operationId: GetFrequencyInterval parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: id in: path description: ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /agriculture-tax-returns: get: tags: - Agriculture Tax Returns summary: List Invoice Reports description: Lists all Agriculture Tax Returns operationId: ListAgricultureTaxReturns parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /yes-no-list: get: tags: - Yes No List summary: Yes/No List description: 'List of key/value for Yes/No. Display is Yes/No, value is Y/N.' operationId: ListYesNo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /transplant-types: get: tags: - Transplant Types summary: Transplant Elite Types description: List of key/value pairs for Transplant Types. operationId: ListTransplantTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /event-priorities: get: tags: - Event Priority Levels summary: List Event Priority Levels description: List of key/value pairs for Event Priority Levels operationId: ListEventPriorityLevels parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /event-statuses: get: tags: - Event Status Types summary: List Event Status Types description: List of key/value pairs for Event Status Types operationId: ListEventStatusTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /language-skill-levels: get: tags: - Language Skill Levels summary: Language Skill Levels description: List of key/value pairs for Language Skill Levels operationId: ListLanguageSkillLevels parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /interface-types: get: tags: - Interface Types summary: Interface Types description: List of key/value pairs for Interface Types operationId: ListInterfaceTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /taxonomy-group-types: get: tags: - Taxonomy Group Types summary: List Taxonomy Group Types description: List of key/value pairs for Taxonomy Group Types operationId: ListTaxonomyGroupTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /employer-contribution-schedule-types: get: tags: - Employer Contribution Schedule Types summary: List Employer Contribution Schedule Types description: List of key/value pairs for Employer Contribution Schedule operationId: ListEmployerContributionSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /age-settings: get: tags: - Age Settings summary: List Age Setting Types description: List of key/value pairs for Age Setting Types which determine how a person's age is calculated. operationId: ListAgeSettings parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /ex-code-result-types: get: tags: - Ex Code Result Types summary: List Ex Code Result Types description: List of key/value pairs for Ex Code Result Types. operationId: ListExCodeResultTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /data-types: get: tags: - Data Types summary: List Data Types description: List of key/value pairs for Data Types. operationId: ListDataTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-codes: get: tags: - Group Codes summary: List Group Codes description: List of key/value pairs for Group Codes. operationId: ListGroupCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /insurance-priorities: get: tags: - Insurance Priorities summary: List Insurance Priorities description: List of key/value pairs for Insurance Priorities. operationId: ListInsurancePriorities parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /pay-frequencies: get: tags: - Pay Frequency summary: List Pay Frequencies description: List of key/value pairs for Pay Frequency. operationId: ListPayFrequencies parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4-fee-options: get: tags: - Context4 Lists summary: List Context4 Fee Options description: List of key/value pairs operationId: ListContext4FeeOptions parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4-payor-types: get: tags: - Context4 Lists summary: List Context4 Payor Types description: List of key/value pairs operationId: ListContext4PayorTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4-ucr-percentages: get: tags: - Context4 Lists summary: List Context4 UCR Percentages description: List of key/value pairs operationId: ListContext4UCRPercentages parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /cob-types: get: tags: - COB Types summary: List COB Types description: List of key/value pairs operationId: ListCOBTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /flex-types: get: tags: - Flex Types summary: List Flex Types description: List of key/value pairs operationId: ListFlexTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /maturity-age-types: get: tags: - Life Options summary: List Maturity Age Types description: List of key/value pairs operationId: ListMaturityAgeTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grace-period-types: get: tags: - Life Options summary: List Grace Period Types description: List of key/value pairs operationId: ListGracePeriodTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disability-interval-types: get: tags: - Disability Options summary: List Disability Interval Types description: List of key/value pairs operationId: ListDisabilityIntervalTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /invoice-statuses: get: tags: - Invoice Status summary: List Invoice Statuses description: List of key/value pairs operationId: ListInvoiceStatuses parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /invoice-types: get: tags: - Invoice Types summary: List Invoice Types description: List of key/value pairs operationId: ListInvoiceTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-queue-types: get: tags: - Claim Queue Types summary: List Invoice Types description: List of key/value pairs for the available Claim Queue Types operationId: ListClaimQueueTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /communication-methods: post: tags: - Communication Methods summary: Create CommunicationMethod description: Creates a new CommunicationMethod operationId: CreateCommunicationMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommunicationMethod' text/json: schema: $ref: '#/components/schemas/CommunicationMethod' application/*+json: schema: $ref: '#/components/schemas/CommunicationMethod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommunicationMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/CommunicationMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/CommunicationMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Communication Methods summary: List CommunicationMethod description: Lists all CommunicationMethod operationId: ListCommunicationMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommunicationMethodListVBAResponse' application/json: schema: $ref: '#/components/schemas/CommunicationMethodListVBAResponse' text/json: schema: $ref: '#/components/schemas/CommunicationMethodListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/communication-methods/{communicationMethod}': get: tags: - Communication Methods summary: Get CommunicationMethod description: Gets CommunicationMethod operationId: GetCommunicationMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: communicationMethod in: path description: Communication Method required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommunicationMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/CommunicationMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/CommunicationMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Communication Methods summary: Update CommunicationMethod description: Updates a specific CommunicationMethod. operationId: UpdateCommunicationMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: communicationMethod in: path description: Communication Method required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommunicationMethod' text/json: schema: $ref: '#/components/schemas/CommunicationMethod' application/*+json: schema: $ref: '#/components/schemas/CommunicationMethod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CommunicationMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/CommunicationMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/CommunicationMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Communication Methods summary: Delete CommunicationMethod description: Deletes an CommunicationMethod operationId: DeleteCommunicationMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: communicationMethod in: path description: Communication Method required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /communication-methods-batch: put: tags: - Communication Methods summary: Create or Update Batch CommunicationMethod description: 'Create or Update multiple CommunicationMethod at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCommunicationMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CommunicationMethod' text/json: schema: type: array items: $ref: '#/components/schemas/CommunicationMethod' application/*+json: schema: type: array items: $ref: '#/components/schemas/CommunicationMethod' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /company-data: get: tags: - Company Data summary: List CompanyData description: Lists all CompanyData operationId: ListCompanyData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CompanyDataListVBAResponse' application/json: schema: $ref: '#/components/schemas/CompanyDataListVBAResponse' text/json: schema: $ref: '#/components/schemas/CompanyDataListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/company-data/{keyValue}': get: tags: - Company Data summary: Get CompanyData description: Gets CompanyData operationId: GetCompanyData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: keyValue in: path description: Key Value required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CompanyDataVBAResponse' application/json: schema: $ref: '#/components/schemas/CompanyDataVBAResponse' text/json: schema: $ref: '#/components/schemas/CompanyDataVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Company Data summary: Update CompanyData description: Updates a specific CompanyData. operationId: UpdateCompanyData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: keyValue in: path description: Key Value required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanyData' text/json: schema: $ref: '#/components/schemas/CompanyData' application/*+json: schema: $ref: '#/components/schemas/CompanyData' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CompanyDataVBAResponse' application/json: schema: $ref: '#/components/schemas/CompanyDataVBAResponse' text/json: schema: $ref: '#/components/schemas/CompanyDataVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contacts: post: tags: - Contacts summary: Create Contact description: Creates a new Contact operationId: CreateContact parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Contact' text/json: schema: $ref: '#/components/schemas/Contact' application/*+json: schema: $ref: '#/components/schemas/Contact' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Contacts summary: List Contact description: Lists all Contact operationId: ListContact parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactListVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactListVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/contacts/{contactKey}': get: tags: - Contacts summary: Get Contact description: Gets Contact operationId: GetContact parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactKey in: path description: Contact Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Contacts summary: Update Contact description: Updates a specific Contact. operationId: UpdateContact parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactKey in: path description: Contact Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Contact' text/json: schema: $ref: '#/components/schemas/Contact' application/*+json: schema: $ref: '#/components/schemas/Contact' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Contacts summary: Delete Contact description: Deletes an Contact operationId: DeleteContact parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactKey in: path description: Contact Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contacts-batch: put: tags: - Contacts summary: Create or Update Batch Contact description: 'Create or Update multiple Contact at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchContact parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Contact' text/json: schema: type: array items: $ref: '#/components/schemas/Contact' application/*+json: schema: type: array items: $ref: '#/components/schemas/Contact' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contact-assignments: post: tags: - Contact Assignments summary: Create ContactAssign description: Creates a new ContactAssign operationId: CreateContactAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactAssign' text/json: schema: $ref: '#/components/schemas/ContactAssign' application/*+json: schema: $ref: '#/components/schemas/ContactAssign' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactAssignVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactAssignVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactAssignVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Contact Assignments summary: List ContactAssign description: Lists all ContactAssign operationId: ListContactAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactAssignListVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactAssignListVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactAssignListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/contact-assignments/{contactAssignKey}': get: tags: - Contact Assignments summary: Get ContactAssign description: Gets ContactAssign operationId: GetContactAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactAssignKey in: path description: ContactAssign Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactAssignVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactAssignVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactAssignVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Contact Assignments summary: Update ContactAssign description: Updates a specific ContactAssign. operationId: UpdateContactAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactAssignKey in: path description: ContactAssign Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactAssign' text/json: schema: $ref: '#/components/schemas/ContactAssign' application/*+json: schema: $ref: '#/components/schemas/ContactAssign' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactAssignVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactAssignVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactAssignVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Contact Assignments summary: Delete ContactAssign description: Deletes an ContactAssign operationId: DeleteContactAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactAssignKey in: path description: ContactAssign Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contact-assignments-batch: put: tags: - Contact Assignments summary: Create or Update Batch ContactAssign description: 'Create or Update multiple ContactAssign at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchContactAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ContactAssign' text/json: schema: type: array items: $ref: '#/components/schemas/ContactAssign' application/*+json: schema: type: array items: $ref: '#/components/schemas/ContactAssign' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contact-categories: post: tags: - Contact Categories summary: Create ContactCategory description: Creates a new ContactCategory operationId: CreateContactCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactCategory' text/json: schema: $ref: '#/components/schemas/ContactCategory' application/*+json: schema: $ref: '#/components/schemas/ContactCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Contact Categories summary: List ContactCategory description: Lists all ContactCategory operationId: ListContactCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/contact-categories/{contactCategory}': get: tags: - Contact Categories summary: Get ContactCategory description: Gets ContactCategory operationId: GetContactCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactCategory in: path description: Contact Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Contact Categories summary: Update ContactCategory description: Updates a specific ContactCategory. operationId: UpdateContactCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactCategory in: path description: Contact Category required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactCategory' text/json: schema: $ref: '#/components/schemas/ContactCategory' application/*+json: schema: $ref: '#/components/schemas/ContactCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Contact Categories summary: Delete ContactCategory description: Deletes an ContactCategory operationId: DeleteContactCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactCategory in: path description: Contact Category required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contact-categories-batch: put: tags: - Contact Categories summary: Create or Update Batch ContactCategory description: 'Create or Update multiple ContactCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchContactCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ContactCategory' text/json: schema: type: array items: $ref: '#/components/schemas/ContactCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/ContactCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contact-emails: post: tags: - Contact Emails summary: Create ContactEmail description: Creates a new ContactEmail operationId: CreateContactEmail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactEmail' text/json: schema: $ref: '#/components/schemas/ContactEmail' application/*+json: schema: $ref: '#/components/schemas/ContactEmail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactEmailVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactEmailVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactEmailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Contact Emails summary: List ContactEmail description: Lists all ContactEmail operationId: ListContactEmail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactEmailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactEmailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactEmailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/contact-emails/{contactEmailKey}': get: tags: - Contact Emails summary: Get ContactEmail description: Gets ContactEmail operationId: GetContactEmail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactEmailKey in: path description: ContactEmail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactEmailVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactEmailVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactEmailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Contact Emails summary: Update ContactEmail description: Updates a specific ContactEmail. operationId: UpdateContactEmail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactEmailKey in: path description: ContactEmail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactEmail' text/json: schema: $ref: '#/components/schemas/ContactEmail' application/*+json: schema: $ref: '#/components/schemas/ContactEmail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactEmailVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactEmailVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactEmailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Contact Emails summary: Delete ContactEmail description: Deletes an ContactEmail operationId: DeleteContactEmail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactEmailKey in: path description: ContactEmail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contact-emails-batch: put: tags: - Contact Emails summary: Create or Update Batch ContactEmail description: 'Create or Update multiple ContactEmail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchContactEmail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ContactEmail' text/json: schema: type: array items: $ref: '#/components/schemas/ContactEmail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ContactEmail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contact-mappings: post: tags: - Contact Mappings summary: Create ContactMapping description: Creates a new ContactMapping operationId: CreateContactMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactMapping' text/json: schema: $ref: '#/components/schemas/ContactMapping' application/*+json: schema: $ref: '#/components/schemas/ContactMapping' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactMappingVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactMappingVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactMappingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Contact Mappings summary: List ContactMapping description: Lists all ContactMapping operationId: ListContactMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactMappingListVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactMappingListVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactMappingListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/contact-mappings/{parentContactKey}/{childContactKey}': get: tags: - Contact Mappings summary: Get ContactMapping description: Gets ContactMapping operationId: GetContactMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: parentContactKey in: path description: Parent Contact Key required: true schema: type: integer format: int32 - name: childContactKey in: path description: Child Contact Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactMappingVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactMappingVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactMappingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Contact Mappings summary: Delete ContactMapping description: Deletes an ContactMapping operationId: DeleteContactMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: parentContactKey in: path description: Parent Contact Key required: true schema: type: integer format: int32 - name: childContactKey in: path description: Child Contact Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contact-mappings-batch: put: tags: - Contact Mappings summary: Create or Update Batch ContactMapping description: 'Create or Update multiple ContactMapping at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchContactMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ContactMapping' text/json: schema: type: array items: $ref: '#/components/schemas/ContactMapping' application/*+json: schema: type: array items: $ref: '#/components/schemas/ContactMapping' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contact-phones: post: tags: - Contact Phone summary: Create ContactPhone description: Creates a new ContactPhone operationId: CreateContactPhone parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactPhone' text/json: schema: $ref: '#/components/schemas/ContactPhone' application/*+json: schema: $ref: '#/components/schemas/ContactPhone' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactPhoneVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactPhoneVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactPhoneVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Contact Phone summary: List ContactPhone description: Lists all ContactPhone operationId: ListContactPhone parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactPhoneListVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactPhoneListVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactPhoneListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/contact-phones/{ContactPhone_Key}': get: tags: - Contact Phone summary: Get ContactPhone description: Gets ContactPhone operationId: GetContactPhone parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ContactPhone_Key in: path description: ContactPhone Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactPhoneVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactPhoneVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactPhoneVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Contact Phone summary: Update ContactPhone description: Updates a specific ContactPhone. operationId: UpdateContactPhone parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ContactPhone_Key in: path description: ContactPhone Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactPhone' text/json: schema: $ref: '#/components/schemas/ContactPhone' application/*+json: schema: $ref: '#/components/schemas/ContactPhone' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactPhoneVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactPhoneVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactPhoneVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Contact Phone summary: Delete ContactPhone description: Deletes an ContactPhone operationId: DeleteContactPhone parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ContactPhone_Key in: path description: ContactPhone Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contact-phones-batch: put: tags: - Contact Phone summary: Create or Update Batch ContactPhone description: 'Create or Update multiple ContactPhone at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchContactPhone parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ContactPhone' text/json: schema: type: array items: $ref: '#/components/schemas/ContactPhone' application/*+json: schema: type: array items: $ref: '#/components/schemas/ContactPhone' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contact-statuses: post: tags: - Contact Statuses summary: Create ContactStatus description: Creates a new ContactStatus operationId: CreateContactStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactStatus' text/json: schema: $ref: '#/components/schemas/ContactStatus' application/*+json: schema: $ref: '#/components/schemas/ContactStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Contact Statuses summary: List ContactStatus description: Lists all ContactStatus operationId: ListContactStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/contact-statuses/{contactStatus}': get: tags: - Contact Statuses summary: Get ContactStatus description: Gets ContactStatus operationId: GetContactStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactStatus in: path description: Contact Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Contact Statuses summary: Update ContactStatus description: Updates a specific ContactStatus. operationId: UpdateContactStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactStatus in: path description: Contact Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactStatus' text/json: schema: $ref: '#/components/schemas/ContactStatus' application/*+json: schema: $ref: '#/components/schemas/ContactStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContactStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ContactStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ContactStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Contact Statuses summary: Delete ContactStatus description: Deletes an ContactStatus operationId: DeleteContactStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contactStatus in: path description: Contact Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contact-statuses-batch: put: tags: - Contact Statuses summary: Create or Update Batch ContactStatus description: 'Create or Update multiple ContactStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchContactStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ContactStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ContactStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ContactStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contribution-schedules: post: tags: - Contribution Schedules summary: Create ContributionSchedule description: Creates a new ContributionSchedule operationId: CreateContributionSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ContributionSchedule' text/json: schema: $ref: '#/components/schemas/ContributionSchedule' application/*+json: schema: $ref: '#/components/schemas/ContributionSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContributionScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/ContributionScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/ContributionScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Contribution Schedules summary: List ContributionSchedule description: Lists all ContributionSchedule operationId: ListContributionSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContributionScheduleListVBAResponse' application/json: schema: $ref: '#/components/schemas/ContributionScheduleListVBAResponse' text/json: schema: $ref: '#/components/schemas/ContributionScheduleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/contribution-schedules/{contributionSchedule}': get: tags: - Contribution Schedules summary: Get ContributionSchedule description: Gets ContributionSchedule operationId: GetContributionSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contributionSchedule in: path description: Contribution Schedule required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContributionScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/ContributionScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/ContributionScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Contribution Schedules summary: Update ContributionSchedule description: Updates a specific ContributionSchedule. operationId: UpdateContributionSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contributionSchedule in: path description: Contribution Schedule required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ContributionSchedule' text/json: schema: $ref: '#/components/schemas/ContributionSchedule' application/*+json: schema: $ref: '#/components/schemas/ContributionSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ContributionScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/ContributionScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/ContributionScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Contribution Schedules summary: Delete ContributionSchedule description: Deletes an ContributionSchedule operationId: DeleteContributionSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contributionSchedule in: path description: Contribution Schedule required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contribution-schedules-batch: put: tags: - Contribution Schedules summary: Create or Update Batch ContributionSchedule description: 'Create or Update multiple ContributionSchedule at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchContributionSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ContributionSchedule' text/json: schema: type: array items: $ref: '#/components/schemas/ContributionSchedule' application/*+json: schema: type: array items: $ref: '#/components/schemas/ContributionSchedule' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-case-indexes: post: tags: - Context4Health Cost Containment CaseIndex summary: Create CostContainContext4CaseIndex description: Creates a new CostContainContext4CaseIndex operationId: CreateCostContainContext4CaseIndex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndex' text/json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndex' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndex' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4CaseIndexVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndexVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndexVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Context4Health Cost Containment CaseIndex summary: List CostContainContext4CaseIndex description: Lists all CostContainContext4CaseIndex operationId: ListCostContainContext4CaseIndex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4CaseIndexListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndexListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndexListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/context4health-cost-containment-case-indexes/{caseIndex}': get: tags: - Context4Health Cost Containment CaseIndex summary: Get CostContainContext4CaseIndex description: Gets CostContainContext4CaseIndex operationId: GetCostContainContext4CaseIndex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseIndex in: path description: CaseIndex required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4CaseIndexVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndexVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndexVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Context4Health Cost Containment CaseIndex summary: Update CostContainContext4CaseIndex description: Updates a specific CostContainContext4CaseIndex. operationId: UpdateCostContainContext4CaseIndex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseIndex in: path description: CaseIndex required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndex' text/json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndex' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndex' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4CaseIndexVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndexVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4CaseIndexVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Context4Health Cost Containment CaseIndex summary: Delete CostContainContext4CaseIndex description: Deletes an CostContainContext4CaseIndex operationId: DeleteCostContainContext4CaseIndex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: caseIndex in: path description: CaseIndex required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-case-indexes-batch: put: tags: - Context4Health Cost Containment CaseIndex summary: Create or Update Batch CostContainContext4CaseIndex description: 'Create or Update multiple CostContainContext4CaseIndex at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainContext4CaseIndex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4CaseIndex' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4CaseIndex' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4CaseIndex' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-categories: post: tags: - Context4Health Cost Containment Category summary: Create CostContainContext4Category description: Creates a new CostContainContext4Category operationId: CreateCostContainContext4Category parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4Category' text/json: schema: $ref: '#/components/schemas/CostContainContext4Category' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4Category' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4CategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4CategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4CategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Context4Health Cost Containment Category summary: List CostContainContext4Category description: Lists all CostContainContext4Category operationId: ListCostContainContext4Category parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4CategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4CategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4CategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/context4health-cost-containment-categories/{category}': get: tags: - Context4Health Cost Containment Category summary: Get CostContainContext4Category description: Gets CostContainContext4Category operationId: GetCostContainContext4Category parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: category in: path description: Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4CategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4CategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4CategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Context4Health Cost Containment Category summary: Update CostContainContext4Category description: Updates a specific CostContainContext4Category. operationId: UpdateCostContainContext4Category parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: category in: path description: Category required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4Category' text/json: schema: $ref: '#/components/schemas/CostContainContext4Category' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4Category' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4CategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4CategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4CategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Context4Health Cost Containment Category summary: Delete CostContainContext4Category description: Deletes an CostContainContext4Category operationId: DeleteCostContainContext4Category parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: category in: path description: Category required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-categories-batch: put: tags: - Context4Health Cost Containment Category summary: Create or Update Batch CostContainContext4Category description: 'Create or Update multiple CostContainContext4Category at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainContext4Category parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4Category' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4Category' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4Category' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-default-actions: post: tags: - Context4Health Cost Containment Default Action summary: Create CostContainContext4DefaultAction description: Creates a new CostContainContext4DefaultAction operationId: CreateCostContainContext4DefaultAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4DefaultAction' text/json: schema: $ref: '#/components/schemas/CostContainContext4DefaultAction' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4DefaultAction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4DefaultActionVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4DefaultActionVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4DefaultActionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Context4Health Cost Containment Default Action summary: List CostContainContext4DefaultAction description: Lists all CostContainContext4DefaultAction operationId: ListCostContainContext4DefaultAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4DefaultActionListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4DefaultActionListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4DefaultActionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/context4health-cost-containment-default-actions/{defaultAction}': get: tags: - Context4Health Cost Containment Default Action summary: Get CostContainContext4DefaultAction description: Gets CostContainContext4DefaultAction operationId: GetCostContainContext4DefaultAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: defaultAction in: path description: DefaultAction required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4DefaultActionVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4DefaultActionVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4DefaultActionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Context4Health Cost Containment Default Action summary: Update CostContainContext4DefaultAction description: Updates a specific CostContainContext4DefaultAction. operationId: UpdateCostContainContext4DefaultAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: defaultAction in: path description: DefaultAction required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4DefaultAction' text/json: schema: $ref: '#/components/schemas/CostContainContext4DefaultAction' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4DefaultAction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4DefaultActionVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4DefaultActionVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4DefaultActionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Context4Health Cost Containment Default Action summary: Delete CostContainContext4DefaultAction description: Deletes an CostContainContext4DefaultAction operationId: DeleteCostContainContext4DefaultAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: defaultAction in: path description: DefaultAction required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-default-actions-batch: put: tags: - Context4Health Cost Containment Default Action summary: Create or Update Batch CostContainContext4DefaultAction description: 'Create or Update multiple CostContainContext4DefaultAction at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainContext4DefaultAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4DefaultAction' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4DefaultAction' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4DefaultAction' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-errors: post: tags: - Context4Health Cost Containment Errors summary: Create CostContainContext4Error description: Creates a new CostContainContext4Error operationId: CreateCostContainContext4Error parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4Error' text/json: schema: $ref: '#/components/schemas/CostContainContext4Error' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4Error' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4ErrorVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4ErrorVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4ErrorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Context4Health Cost Containment Errors summary: List CostContainContext4Error description: Lists all CostContainContext4Error operationId: ListCostContainContext4Error parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4ErrorListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4ErrorListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4ErrorListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/context4health-cost-containment-errors/{errorKey}': get: tags: - Context4Health Cost Containment Errors summary: Get CostContainContext4Error description: Gets CostContainContext4Error operationId: GetCostContainContext4Error parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorKey in: path description: Error Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4ErrorVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4ErrorVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4ErrorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Context4Health Cost Containment Errors summary: Update CostContainContext4Error description: Updates a specific CostContainContext4Error. operationId: UpdateCostContainContext4Error parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorKey in: path description: Error Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4Error' text/json: schema: $ref: '#/components/schemas/CostContainContext4Error' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4Error' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4ErrorVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4ErrorVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4ErrorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Context4Health Cost Containment Errors summary: Delete CostContainContext4Error description: Deletes an CostContainContext4Error operationId: DeleteCostContainContext4Error parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorKey in: path description: Error Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-errors-batch: put: tags: - Context4Health Cost Containment Errors summary: Create or Update Batch CostContainContext4Error description: 'Create or Update multiple CostContainContext4Error at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainContext4Error parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4Error' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4Error' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4Error' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-ex-codes: post: tags: - Context4Health Cost Containment Ex Codes summary: Create CostContainContext4ExCode description: Creates a new CostContainContext4ExCode operationId: CreateCostContainContext4ExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4ExCode' text/json: schema: $ref: '#/components/schemas/CostContainContext4ExCode' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4ExCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4ExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4ExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4ExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Context4Health Cost Containment Ex Codes summary: List CostContainContext4ExCode description: Lists all CostContainContext4ExCode operationId: ListCostContainContext4ExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4ExCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4ExCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4ExCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/context4health-cost-containment-ex-codes/{exCodeKey}': get: tags: - Context4Health Cost Containment Ex Codes summary: Get CostContainContext4ExCode description: Gets CostContainContext4ExCode operationId: GetCostContainContext4ExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: exCodeKey in: path description: ExCode Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4ExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4ExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4ExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Context4Health Cost Containment Ex Codes summary: Update CostContainContext4ExCode description: Updates a specific CostContainContext4ExCode. operationId: UpdateCostContainContext4ExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: exCodeKey in: path description: ExCode Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4ExCode' text/json: schema: $ref: '#/components/schemas/CostContainContext4ExCode' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4ExCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4ExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4ExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4ExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Context4Health Cost Containment Ex Codes summary: Delete CostContainContext4ExCode description: Deletes an CostContainContext4ExCode operationId: DeleteCostContainContext4ExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: exCodeKey in: path description: ExCode Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-ex-codes-batch: put: tags: - Context4Health Cost Containment Ex Codes summary: Create or Update Batch CostContainContext4ExCode description: 'Create or Update multiple CostContainContext4ExCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainContext4ExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4ExCode' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4ExCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4ExCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-message-types: post: tags: - Context4Health Cost Containment Message Types summary: Create CostContainContext4MessageType description: Creates a new CostContainContext4MessageType operationId: CreateCostContainContext4MessageType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4MessageType' text/json: schema: $ref: '#/components/schemas/CostContainContext4MessageType' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4MessageType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4MessageTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4MessageTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4MessageTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Context4Health Cost Containment Message Types summary: List CostContainContext4MessageType description: Lists all CostContainContext4MessageType operationId: ListCostContainContext4MessageType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4MessageTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4MessageTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4MessageTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/context4health-cost-containment-message-types/{messageType}': get: tags: - Context4Health Cost Containment Message Types summary: Get CostContainContext4MessageType description: Gets CostContainContext4MessageType operationId: GetCostContainContext4MessageType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: messageType in: path description: MessageType required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4MessageTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4MessageTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4MessageTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Context4Health Cost Containment Message Types summary: Update CostContainContext4MessageType description: Updates a specific CostContainContext4MessageType. operationId: UpdateCostContainContext4MessageType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: messageType in: path description: MessageType required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4MessageType' text/json: schema: $ref: '#/components/schemas/CostContainContext4MessageType' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4MessageType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4MessageTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4MessageTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4MessageTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Context4Health Cost Containment Message Types summary: Delete CostContainContext4MessageType description: Deletes an CostContainContext4MessageType operationId: DeleteCostContainContext4MessageType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: messageType in: path description: MessageType required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-message-types-batch: put: tags: - Context4Health Cost Containment Message Types summary: Create or Update Batch CostContainContext4MessageType description: 'Create or Update multiple CostContainContext4MessageType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainContext4MessageType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4MessageType' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4MessageType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4MessageType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-options: post: tags: - Context4Health Cost Containment Options summary: Create CostContainContext4Option description: Creates a new CostContainContext4Option operationId: CreateCostContainContext4Option parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4Option' text/json: schema: $ref: '#/components/schemas/CostContainContext4Option' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4Option' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4OptionVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4OptionVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4OptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Context4Health Cost Containment Options summary: List CostContainContext4Option description: Lists all CostContainContext4Option operationId: ListCostContainContext4Option parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: query description: Plan ID schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4OptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4OptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4OptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/context4health-cost-containment-options/{optionKey}': get: tags: - Context4Health Cost Containment Options summary: Get CostContainContext4Option description: Gets CostContainContext4Option operationId: GetCostContainContext4Option parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: optionKey in: path description: Option Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4OptionVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4OptionVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4OptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Context4Health Cost Containment Options summary: Update CostContainContext4Option description: Updates a specific CostContainContext4Option. operationId: UpdateCostContainContext4Option parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: optionKey in: path description: Option Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4Option' text/json: schema: $ref: '#/components/schemas/CostContainContext4Option' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4Option' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4OptionVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4OptionVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4OptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Context4Health Cost Containment Options summary: Delete CostContainContext4Option description: Deletes an CostContainContext4Option operationId: DeleteCostContainContext4Option parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: optionKey in: path description: Option Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-options-batch: put: tags: - Context4Health Cost Containment Options summary: Create or Update Batch CostContainContext4Option description: 'Create or Update multiple CostContainContext4Option at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainContext4Option parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4Option' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4Option' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4Option' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-option-pricing: post: tags: - Context4Health Cost Containment Option Pricing summary: Create CostContainContext4OptionPricing description: Creates a new CostContainContext4OptionPricing operationId: CreateCostContainContext4OptionPricing parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricing' text/json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricing' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricing' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4OptionPricingVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricingVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Context4Health Cost Containment Option Pricing summary: List CostContainContext4OptionPricing description: Lists all CostContainContext4OptionPricing operationId: ListCostContainContext4OptionPricing parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: query description: Plan ID schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4OptionPricingListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricingListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricingListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/context4health-cost-containment-option-pricing/{optionKey}': get: tags: - Context4Health Cost Containment Option Pricing summary: Get CostContainContext4OptionPricing description: Gets CostContainContext4OptionPricing operationId: GetCostContainContext4OptionPricing parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: optionKey in: path description: Option Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4OptionPricingVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricingVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Context4Health Cost Containment Option Pricing summary: Update CostContainContext4OptionPricing description: Updates a specific CostContainContext4OptionPricing. operationId: UpdateCostContainContext4OptionPricing parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: optionKey in: path description: Option Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricing' text/json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricing' application/*+json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricing' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainContext4OptionPricingVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricingVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainContext4OptionPricingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Context4Health Cost Containment Option Pricing summary: Delete CostContainContext4OptionPricing description: Deletes an CostContainContext4OptionPricing operationId: DeleteCostContainContext4OptionPricing parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: optionKey in: path description: Option Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /context4health-cost-containment-option-pricing-batch: put: tags: - Context4Health Cost Containment Option Pricing summary: Create or Update Batch CostContainContext4OptionPricing description: 'Create or Update multiple CostContainContext4OptionPricing at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainContext4OptionPricing parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4OptionPricing' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4OptionPricing' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainContext4OptionPricing' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/zelis-claim-detail-repricing/batches/{batchNumber}/claims/{batchClaim}/details': post: tags: - Zelis Cost Containment Claim Detail Repricing summary: Create CostContainZelisClaimDetailReprice description: Creates a new CostContainZelisClaimDetailReprice operationId: CreateCostContainZelisClaimDetailReprice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailReprice' text/json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailReprice' application/*+json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailReprice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailRepriceVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailRepriceVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailRepriceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Zelis Cost Containment Claim Detail Repricing summary: List CostContainZelisClaimDetailReprice description: Lists all CostContainZelisClaimDetailReprice for the given batchNumber and batchClaim operationId: ListCostContainZelisClaimDetailReprice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailRepriceListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailRepriceListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailRepriceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/zelis-claim-detail-repricing/batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}': get: tags: - Zelis Cost Containment Claim Detail Repricing summary: Get CostContainZelisClaimDetailReprice description: Gets CostContainZelisClaimDetailReprice operationId: GetCostContainZelisClaimDetailReprice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailRepriceVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailRepriceVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailRepriceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Zelis Cost Containment Claim Detail Repricing summary: Update CostContainZelisClaimDetailReprice description: Updates a specific CostContainZelisClaimDetailReprice. operationId: UpdateCostContainZelisClaimDetailReprice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailReprice' text/json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailReprice' application/*+json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailReprice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailRepriceVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailRepriceVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisClaimDetailRepriceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Zelis Cost Containment Claim Detail Repricing summary: Delete CostContainZelisClaimDetailReprice description: Deletes an CostContainZelisClaimDetailReprice operationId: DeleteCostContainZelisClaimDetailReprice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 - name: claimSeq in: path description: Claim Seq required: true schema: type: string - name: adjustmentSeq in: path description: Adjustment Seq required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/zelis-claim-detail-repricing/batches/{batchNumber}/claims/{batchClaim}/details-batch': put: tags: - Zelis Cost Containment Claim Detail Repricing summary: Create or Update Batch CostContainZelisClaimDetailReprice description: 'Create or Update multiple CostContainZelisClaimDetailReprice at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainZelisClaimDetailReprice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisClaimDetailReprice' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisClaimDetailReprice' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisClaimDetailReprice' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /zelis-claim-repricing: post: tags: - Zelis Cost Containment Claim Repricing summary: Create CostContainZelisClaimReprice description: Creates a new CostContainZelisClaimReprice operationId: CreateCostContainZelisClaimReprice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainZelisClaimReprice' text/json: schema: $ref: '#/components/schemas/CostContainZelisClaimReprice' application/*+json: schema: $ref: '#/components/schemas/CostContainZelisClaimReprice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisClaimRepriceVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisClaimRepriceVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisClaimRepriceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Zelis Cost Containment Claim Repricing summary: List CostContainZelisClaimReprice description: Lists all CostContainZelisClaimReprice operationId: ListCostContainZelisClaimReprice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisClaimRepriceListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisClaimRepriceListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisClaimRepriceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/zelis-claim-repricing/batches/{batchNumber}/claims/{batchClaim}': get: tags: - Zelis Cost Containment Claim Repricing summary: Get CostContainZelisClaimReprice description: Gets CostContainZelisClaimReprice operationId: GetCostContainZelisClaimReprice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisClaimRepriceVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisClaimRepriceVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisClaimRepriceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Zelis Cost Containment Claim Repricing summary: Update CostContainZelisClaimReprice description: Updates a specific CostContainZelisClaimReprice. operationId: UpdateCostContainZelisClaimReprice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainZelisClaimReprice' text/json: schema: $ref: '#/components/schemas/CostContainZelisClaimReprice' application/*+json: schema: $ref: '#/components/schemas/CostContainZelisClaimReprice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisClaimRepriceVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisClaimRepriceVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisClaimRepriceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Zelis Cost Containment Claim Repricing summary: Delete CostContainZelisClaimReprice description: Deletes an CostContainZelisClaimReprice operationId: DeleteCostContainZelisClaimReprice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /zelis-claim-repricing-batch: put: tags: - Zelis Cost Containment Claim Repricing summary: Create or Update Batch CostContainZelisClaimReprice description: 'Create or Update multiple CostContainZelisClaimReprice at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainZelisClaimReprice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisClaimReprice' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisClaimReprice' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisClaimReprice' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /zelis-edit-codes: post: tags: - Zelis Cost Containment Edit Codes summary: Create CostContainZelisEditCode description: Creates a new CostContainZelisEditCode operationId: CreateCostContainZelisEditCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainZelisEditCode' text/json: schema: $ref: '#/components/schemas/CostContainZelisEditCode' application/*+json: schema: $ref: '#/components/schemas/CostContainZelisEditCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisEditCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisEditCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisEditCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Zelis Cost Containment Edit Codes summary: List CostContainZelisEditCode description: Lists all CostContainZelisEditCode operationId: ListCostContainZelisEditCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisEditCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisEditCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisEditCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/zelis-edit-codes/{editCode}': get: tags: - Zelis Cost Containment Edit Codes summary: Get CostContainZelisEditCode description: Gets CostContainZelisEditCode operationId: GetCostContainZelisEditCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: editCode in: path description: EditCode required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisEditCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisEditCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisEditCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Zelis Cost Containment Edit Codes summary: Update CostContainZelisEditCode description: Updates a specific CostContainZelisEditCode. operationId: UpdateCostContainZelisEditCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: editCode in: path description: EditCode required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainZelisEditCode' text/json: schema: $ref: '#/components/schemas/CostContainZelisEditCode' application/*+json: schema: $ref: '#/components/schemas/CostContainZelisEditCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisEditCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisEditCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisEditCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Zelis Cost Containment Edit Codes summary: Delete CostContainZelisEditCode description: Deletes an CostContainZelisEditCode operationId: DeleteCostContainZelisEditCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: editCode in: path description: EditCode required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /zelis-edit-codes-batch: put: tags: - Zelis Cost Containment Edit Codes summary: Create or Update Batch CostContainZelisEditCode description: 'Create or Update multiple CostContainZelisEditCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainZelisEditCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisEditCode' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisEditCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisEditCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /zelis-eob-codes: post: tags: - Zelis Cost Containment EOB Codes summary: Create CostContainZelisEOBCode description: Creates a new CostContainZelisEOBCode operationId: CreateCostContainZelisEOBCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainZelisEOBCode' text/json: schema: $ref: '#/components/schemas/CostContainZelisEOBCode' application/*+json: schema: $ref: '#/components/schemas/CostContainZelisEOBCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisEOBCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisEOBCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisEOBCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Zelis Cost Containment EOB Codes summary: List CostContainZelisEOBCode description: Lists all CostContainZelisEOBCode operationId: ListCostContainZelisEOBCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisEOBCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisEOBCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisEOBCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/zelis-eob-codes/{eobCode}': get: tags: - Zelis Cost Containment EOB Codes summary: Get CostContainZelisEOBCode description: Gets CostContainZelisEOBCode operationId: GetCostContainZelisEOBCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eobCode in: path description: EOBCode required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisEOBCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisEOBCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisEOBCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Zelis Cost Containment EOB Codes summary: Update CostContainZelisEOBCode description: Updates a specific CostContainZelisEOBCode. operationId: UpdateCostContainZelisEOBCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eobCode in: path description: EOBCode required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainZelisEOBCode' text/json: schema: $ref: '#/components/schemas/CostContainZelisEOBCode' application/*+json: schema: $ref: '#/components/schemas/CostContainZelisEOBCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisEOBCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisEOBCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisEOBCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Zelis Cost Containment EOB Codes summary: Delete CostContainZelisEOBCode description: Deletes an CostContainZelisEOBCode operationId: DeleteCostContainZelisEOBCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eobCode in: path description: EOBCode required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /zelis-eob-codes-batch: put: tags: - Zelis Cost Containment EOB Codes summary: Create or Update Batch CostContainZelisEOBCode description: 'Create or Update multiple CostContainZelisEOBCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainZelisEOBCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisEOBCode' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisEOBCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisEOBCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /cost-contain-zelis-ex-codes: post: tags: - Cost Contain Zelis ExCodes summary: Create CostContainZelisExCode description: Creates a new CostContainZelisExCode operationId: CreateCostContainZelisExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainZelisExCode' text/json: schema: $ref: '#/components/schemas/CostContainZelisExCode' application/*+json: schema: $ref: '#/components/schemas/CostContainZelisExCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Cost Contain Zelis ExCodes summary: List CostContainZelisExCode description: Lists all CostContainZelisExCode operationId: ListCostContainZelisExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisExCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisExCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisExCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/cost-contain-zelis-ex-codes/{exCode}': get: tags: - Cost Contain Zelis ExCodes summary: Get CostContainZelisExCode description: Gets CostContainZelisExCode operationId: GetCostContainZelisExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: exCode in: path description: Ex Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Cost Contain Zelis ExCodes summary: Update CostContainZelisExCode description: Updates a specific CostContainZelisExCode. operationId: UpdateCostContainZelisExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: exCode in: path description: Ex Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainZelisExCode' text/json: schema: $ref: '#/components/schemas/CostContainZelisExCode' application/*+json: schema: $ref: '#/components/schemas/CostContainZelisExCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Cost Contain Zelis ExCodes summary: Delete CostContainZelisExCode description: Deletes an CostContainZelisExCode operationId: DeleteCostContainZelisExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: exCode in: path description: Ex Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /cost-contain-zelis-ex-codes-batch: put: tags: - Cost Contain Zelis ExCodes summary: Create or Update Batch CostContainZelisExCode description: 'Create or Update multiple CostContainZelisExCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainZelisExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisExCode' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisExCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisExCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /zelis-polls: post: tags: - Zelis Cost Containment Polls summary: Create CostContainZelisPoll description: Creates a new CostContainZelisPoll operationId: CreateCostContainZelisPoll parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainZelisPoll' text/json: schema: $ref: '#/components/schemas/CostContainZelisPoll' application/*+json: schema: $ref: '#/components/schemas/CostContainZelisPoll' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisPollVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisPollVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisPollVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Zelis Cost Containment Polls summary: List CostContainZelisPoll description: Lists all CostContainZelisPoll operationId: ListCostContainZelisPoll parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisPollListVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisPollListVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisPollListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/zelis-polls/{costContainZelisPollKey}': get: tags: - Zelis Cost Containment Polls summary: Get CostContainZelisPoll description: Gets CostContainZelisPoll operationId: GetCostContainZelisPoll parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: costContainZelisPollKey in: path description: CostContainZelisPoll Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisPollVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisPollVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisPollVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Zelis Cost Containment Polls summary: Update CostContainZelisPoll description: Updates a specific CostContainZelisPoll. operationId: UpdateCostContainZelisPoll parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: costContainZelisPollKey in: path description: CostContainZelisPoll Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CostContainZelisPoll' text/json: schema: $ref: '#/components/schemas/CostContainZelisPoll' application/*+json: schema: $ref: '#/components/schemas/CostContainZelisPoll' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CostContainZelisPollVBAResponse' application/json: schema: $ref: '#/components/schemas/CostContainZelisPollVBAResponse' text/json: schema: $ref: '#/components/schemas/CostContainZelisPollVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Zelis Cost Containment Polls summary: Delete CostContainZelisPoll description: Deletes an CostContainZelisPoll operationId: DeleteCostContainZelisPoll parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: costContainZelisPollKey in: path description: CostContainZelisPoll Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /zelis-polls-batch: put: tags: - Zelis Cost Containment Polls summary: Create or Update Batch CostContainZelisPoll description: 'Create or Update multiple CostContainZelisPoll at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCostContainZelisPoll parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisPoll' text/json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisPoll' application/*+json: schema: type: array items: $ref: '#/components/schemas/CostContainZelisPoll' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /countries: post: tags: - Country summary: Create Country description: Creates a new Country operationId: CreateCountry parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Country' text/json: schema: $ref: '#/components/schemas/Country' application/*+json: schema: $ref: '#/components/schemas/Country' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CountryVBAResponse' application/json: schema: $ref: '#/components/schemas/CountryVBAResponse' text/json: schema: $ref: '#/components/schemas/CountryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Country summary: List Countries description: List all available countries operationId: ListCountries parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CountryListVBAResponse' application/json: schema: $ref: '#/components/schemas/CountryListVBAResponse' text/json: schema: $ref: '#/components/schemas/CountryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/countries/{countryID}': get: tags: - Country summary: Get Country description: Gets Country operationId: GetCountry parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: countryID in: path description: Country ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CountryVBAResponse' application/json: schema: $ref: '#/components/schemas/CountryVBAResponse' text/json: schema: $ref: '#/components/schemas/CountryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Country summary: Update Country description: Updates a specific Country. operationId: UpdateCountry parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: countryID in: path description: Country ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Country' text/json: schema: $ref: '#/components/schemas/Country' application/*+json: schema: $ref: '#/components/schemas/Country' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CountryVBAResponse' application/json: schema: $ref: '#/components/schemas/CountryVBAResponse' text/json: schema: $ref: '#/components/schemas/CountryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Country summary: Delete Country description: Deletes an Country operationId: DeleteCountry parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: countryID in: path description: Country ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /countries-batch: put: tags: - Country summary: Create or Update Batch Country description: 'Create or Update multiple Country at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCountry parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Country' text/json: schema: type: array items: $ref: '#/components/schemas/Country' application/*+json: schema: type: array items: $ref: '#/components/schemas/Country' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /country-dialing-codes: post: tags: - Country Dialing Codes summary: Create CountryDialingCode description: Creates a new CountryDialingCode operationId: CreateCountryDialingCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CountryDialingCode' text/json: schema: $ref: '#/components/schemas/CountryDialingCode' application/*+json: schema: $ref: '#/components/schemas/CountryDialingCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CountryDialingCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CountryDialingCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CountryDialingCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Country Dialing Codes summary: List CountryDialingCode description: Lists all CountryDialingCode operationId: ListCountryDialingCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CountryDialingCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CountryDialingCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CountryDialingCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/country-dialing-codes/{countryID}/{countryCode}': get: tags: - Country Dialing Codes summary: Get CountryDialingCode description: Gets CountryDialingCode operationId: GetCountryDialingCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: countryID in: path description: Country ID required: true schema: type: string - name: countryCode in: path description: Country Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CountryDialingCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CountryDialingCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CountryDialingCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Country Dialing Codes summary: Update CountryDialingCode description: Updates a specific CountryDialingCode. operationId: UpdateCountryDialingCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: countryID in: path description: Country ID required: true schema: type: string - name: countryCode in: path description: Country Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CountryDialingCode' text/json: schema: $ref: '#/components/schemas/CountryDialingCode' application/*+json: schema: $ref: '#/components/schemas/CountryDialingCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CountryDialingCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/CountryDialingCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/CountryDialingCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Country Dialing Codes summary: Delete CountryDialingCode description: Deletes an CountryDialingCode operationId: DeleteCountryDialingCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: countryID in: path description: Country ID required: true schema: type: string - name: countryCode in: path description: Country Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /country-dialing-codes-batch: put: tags: - Country Dialing Codes summary: Create or Update Batch CountryDialingCode description: 'Create or Update multiple CountryDialingCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCountryDialingCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CountryDialingCode' text/json: schema: type: array items: $ref: '#/components/schemas/CountryDialingCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/CountryDialingCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /counties: post: tags: - County summary: Create County description: Creates a new County operationId: CreateCounty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/County' text/json: schema: $ref: '#/components/schemas/County' application/*+json: schema: $ref: '#/components/schemas/County' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CountyVBAResponse' application/json: schema: $ref: '#/components/schemas/CountyVBAResponse' text/json: schema: $ref: '#/components/schemas/CountyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - County summary: List Counties description: List all available counties operationId: ListCounties parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CountyListVBAResponse' application/json: schema: $ref: '#/components/schemas/CountyListVBAResponse' text/json: schema: $ref: '#/components/schemas/CountyListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/counties/{countyCode}': get: tags: - County summary: Get County description: Gets County operationId: GetCounty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: countyCode in: path description: County Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CountyVBAResponse' application/json: schema: $ref: '#/components/schemas/CountyVBAResponse' text/json: schema: $ref: '#/components/schemas/CountyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - County summary: Update County description: Updates a specific County. operationId: UpdateCounty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: countyCode in: path description: County Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/County' text/json: schema: $ref: '#/components/schemas/County' application/*+json: schema: $ref: '#/components/schemas/County' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CountyVBAResponse' application/json: schema: $ref: '#/components/schemas/CountyVBAResponse' text/json: schema: $ref: '#/components/schemas/CountyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - County summary: Delete County description: Deletes an County operationId: DeleteCounty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: countyCode in: path description: County Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /counties-batch: put: tags: - County summary: Create or Update Batch County description: 'Create or Update multiple County at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCounty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/County' text/json: schema: type: array items: $ref: '#/components/schemas/County' application/*+json: schema: type: array items: $ref: '#/components/schemas/County' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /coverage-types: post: tags: - Coverage Types summary: Create CoverageType description: Creates a new CoverageType operationId: CreateCoverageType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CoverageType' text/json: schema: $ref: '#/components/schemas/CoverageType' application/*+json: schema: $ref: '#/components/schemas/CoverageType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CoverageTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CoverageTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CoverageTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Coverage Types summary: List CoverageType description: 'Lists all CoverageType ' operationId: ListCoverageType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CoverageTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CoverageTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CoverageTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/coverage-types/{coverageType}': get: tags: - Coverage Types summary: Get CoverageType description: Gets CoverageType operationId: GetCoverageType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: coverageType in: path description: Coverage Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CoverageTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CoverageTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CoverageTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Coverage Types summary: Update CoverageType description: Updates a specific CoverageType. operationId: UpdateCoverageType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: coverageType in: path description: Coverage Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CoverageType' text/json: schema: $ref: '#/components/schemas/CoverageType' application/*+json: schema: $ref: '#/components/schemas/CoverageType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CoverageTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CoverageTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CoverageTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Coverage Types summary: Delete CoverageType description: Deletes an CoverageType operationId: DeleteCoverageType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: coverageType in: path description: Coverage Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /coverage-types-batch: put: tags: - Coverage Types summary: Create or Update Batch CoverageType description: 'Create or Update multiple CoverageType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCoverageType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CoverageType' text/json: schema: type: array items: $ref: '#/components/schemas/CoverageType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CoverageType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-amounts: post: tags: - Credentialing Amounts summary: Create CredAmount description: Creates a new CredAmount operationId: CreateCredAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredAmount' text/json: schema: $ref: '#/components/schemas/CredAmount' application/*+json: schema: $ref: '#/components/schemas/CredAmount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAmountVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAmountVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAmountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Amounts summary: List CredAmount description: Lists all CredAmount operationId: ListCredAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAmountListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAmountListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAmountListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-amounts/{credAmountKey}': get: tags: - Credentialing Amounts summary: Get CredAmount description: Gets CredAmount operationId: GetCredAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAmountKey in: path description: CredAmount Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAmountVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAmountVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAmountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Amounts summary: Update CredAmount description: Updates a specific CredAmount. operationId: UpdateCredAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAmountKey in: path description: CredAmount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredAmount' text/json: schema: $ref: '#/components/schemas/CredAmount' application/*+json: schema: $ref: '#/components/schemas/CredAmount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAmountVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAmountVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAmountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Amounts summary: Delete CredAmount description: Deletes an CredAmount operationId: DeleteCredAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAmountKey in: path description: CredAmount Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-amounts-batch: put: tags: - Credentialing Amounts summary: Create or Update Batch CredAmount description: 'Create or Update multiple CredAmount at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredAmount' text/json: schema: type: array items: $ref: '#/components/schemas/CredAmount' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredAmount' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-attestation-methods: post: tags: - Credentialing Attestation Methods summary: Create CredAttestationMethod description: Creates a new CredAttestationMethod operationId: CreateCredAttestationMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredAttestationMethod' text/json: schema: $ref: '#/components/schemas/CredAttestationMethod' application/*+json: schema: $ref: '#/components/schemas/CredAttestationMethod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Attestation Methods summary: List CredAttestationMethod description: Lists all CredAttestationMethod operationId: ListCredAttestationMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationMethodListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationMethodListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationMethodListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-attestation-methods/{credAttestationMethodKey}': get: tags: - Credentialing Attestation Methods summary: Get CredAttestationMethod description: Gets CredAttestationMethod operationId: GetCredAttestationMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAttestationMethodKey in: path description: CredAttestationMethod Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Attestation Methods summary: Update CredAttestationMethod description: Updates a specific CredAttestationMethod. operationId: UpdateCredAttestationMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAttestationMethodKey in: path description: CredAttestationMethod Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredAttestationMethod' text/json: schema: $ref: '#/components/schemas/CredAttestationMethod' application/*+json: schema: $ref: '#/components/schemas/CredAttestationMethod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Attestation Methods summary: Delete CredAttestationMethod description: Deletes an CredAttestationMethod operationId: DeleteCredAttestationMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAttestationMethodKey in: path description: CredAttestationMethod Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-attestation-methods-batch: put: tags: - Credentialing Attestation Methods summary: Create or Update Batch CredAttestationMethod description: 'Create or Update multiple CredAttestationMethod at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredAttestationMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredAttestationMethod' text/json: schema: type: array items: $ref: '#/components/schemas/CredAttestationMethod' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredAttestationMethod' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-attestation-questions: post: tags: - Credentialing Attestation Questions summary: Create CredAttestationQuestion description: Creates a new CredAttestationQuestion operationId: CreateCredAttestationQuestion parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredAttestationQuestion' text/json: schema: $ref: '#/components/schemas/CredAttestationQuestion' application/*+json: schema: $ref: '#/components/schemas/CredAttestationQuestion' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationQuestionVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationQuestionVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationQuestionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Attestation Questions summary: List CredAttestationQuestion description: Lists all CredAttestationQuestion operationId: ListCredAttestationQuestion parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationQuestionListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationQuestionListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationQuestionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-attestation-questions/{credAttestationQuestionKey}': get: tags: - Credentialing Attestation Questions summary: Get CredAttestationQuestion description: Gets CredAttestationQuestion operationId: GetCredAttestationQuestion parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAttestationQuestionKey in: path description: CredAttestationQuestion Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationQuestionVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationQuestionVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationQuestionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Attestation Questions summary: Update CredAttestationQuestion description: Updates a specific CredAttestationQuestion. operationId: UpdateCredAttestationQuestion parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAttestationQuestionKey in: path description: CredAttestationQuestion Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredAttestationQuestion' text/json: schema: $ref: '#/components/schemas/CredAttestationQuestion' application/*+json: schema: $ref: '#/components/schemas/CredAttestationQuestion' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationQuestionVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationQuestionVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationQuestionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Attestation Questions summary: Delete CredAttestationQuestion description: Deletes an CredAttestationQuestion operationId: DeleteCredAttestationQuestion parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAttestationQuestionKey in: path description: CredAttestationQuestion Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-attestation-questions-batch: put: tags: - Credentialing Attestation Questions summary: Create or Update Batch CredAttestationQuestion description: 'Create or Update multiple CredAttestationQuestion at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredAttestationQuestion parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredAttestationQuestion' text/json: schema: type: array items: $ref: '#/components/schemas/CredAttestationQuestion' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredAttestationQuestion' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-attestation-sources: post: tags: - Credentialing Attestation Sources summary: Create CredAttestationSource description: Creates a new CredAttestationSource operationId: CreateCredAttestationSource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredAttestationSource' text/json: schema: $ref: '#/components/schemas/CredAttestationSource' application/*+json: schema: $ref: '#/components/schemas/CredAttestationSource' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationSourceVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationSourceVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationSourceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Attestation Sources summary: List CredAttestationSource description: Lists all CredAttestationSource operationId: ListCredAttestationSource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationSourceListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationSourceListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationSourceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-attestation-sources/{credAttestationSourceKey}': get: tags: - Credentialing Attestation Sources summary: Get CredAttestationSource description: Gets CredAttestationSource operationId: GetCredAttestationSource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAttestationSourceKey in: path description: CredAttestationSource Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationSourceVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationSourceVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationSourceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Attestation Sources summary: Update CredAttestationSource description: Updates a specific CredAttestationSource. operationId: UpdateCredAttestationSource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAttestationSourceKey in: path description: CredAttestationSource Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredAttestationSource' text/json: schema: $ref: '#/components/schemas/CredAttestationSource' application/*+json: schema: $ref: '#/components/schemas/CredAttestationSource' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationSourceVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationSourceVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationSourceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Attestation Sources summary: Delete CredAttestationSource description: Deletes an CredAttestationSource operationId: DeleteCredAttestationSource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAttestationSourceKey in: path description: CredAttestationSource Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-attestation-sources-batch: put: tags: - Credentialing Attestation Sources summary: Create or Update Batch CredAttestationSource description: 'Create or Update multiple CredAttestationSource at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredAttestationSource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredAttestationSource' text/json: schema: type: array items: $ref: '#/components/schemas/CredAttestationSource' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredAttestationSource' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-attestation-types: post: tags: - Credentialing Attestation Types summary: Create CredAttestationType description: Creates a new CredAttestationType operationId: CreateCredAttestationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredAttestationType' text/json: schema: $ref: '#/components/schemas/CredAttestationType' application/*+json: schema: $ref: '#/components/schemas/CredAttestationType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Attestation Types summary: List CredAttestationType description: Lists all CredAttestationType operationId: ListCredAttestationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-attestation-types/{credAttestationTypeKey}': get: tags: - Credentialing Attestation Types summary: Get CredAttestationType description: Gets CredAttestationType operationId: GetCredAttestationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAttestationTypeKey in: path description: CredAttestationType Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Attestation Types summary: Update CredAttestationType description: Updates a specific CredAttestationType. operationId: UpdateCredAttestationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAttestationTypeKey in: path description: CredAttestationType Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredAttestationType' text/json: schema: $ref: '#/components/schemas/CredAttestationType' application/*+json: schema: $ref: '#/components/schemas/CredAttestationType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredAttestationTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredAttestationTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredAttestationTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Attestation Types summary: Delete CredAttestationType description: Deletes an CredAttestationType operationId: DeleteCredAttestationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credAttestationTypeKey in: path description: CredAttestationType Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-attestation-types-batch: put: tags: - Credentialing Attestation Types summary: Create or Update Batch CredAttestationType description: 'Create or Update multiple CredAttestationType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredAttestationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredAttestationType' text/json: schema: type: array items: $ref: '#/components/schemas/CredAttestationType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredAttestationType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-carriers: post: tags: - Credentialing Carriers summary: Create CredCarrier description: Creates a new CredCarrier operationId: CreateCredCarrier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredCarrier' text/json: schema: $ref: '#/components/schemas/CredCarrier' application/*+json: schema: $ref: '#/components/schemas/CredCarrier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredCarrierVBAResponse' application/json: schema: $ref: '#/components/schemas/CredCarrierVBAResponse' text/json: schema: $ref: '#/components/schemas/CredCarrierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Carriers summary: List CredCarrier description: Lists all CredCarrier operationId: ListCredCarrier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredCarrierListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredCarrierListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredCarrierListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-carriers/{credCarrierKey}': get: tags: - Credentialing Carriers summary: Get CredCarrier description: Gets CredCarrier operationId: GetCredCarrier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credCarrierKey in: path description: CredCarrier Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredCarrierVBAResponse' application/json: schema: $ref: '#/components/schemas/CredCarrierVBAResponse' text/json: schema: $ref: '#/components/schemas/CredCarrierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Carriers summary: Update CredCarrier description: Updates a specific CredCarrier. operationId: UpdateCredCarrier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credCarrierKey in: path description: CredCarrier Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredCarrier' text/json: schema: $ref: '#/components/schemas/CredCarrier' application/*+json: schema: $ref: '#/components/schemas/CredCarrier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredCarrierVBAResponse' application/json: schema: $ref: '#/components/schemas/CredCarrierVBAResponse' text/json: schema: $ref: '#/components/schemas/CredCarrierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Carriers summary: Delete CredCarrier description: Deletes an CredCarrier operationId: DeleteCredCarrier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credCarrierKey in: path description: CredCarrier Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-carriers-batch: put: tags: - Credentialing Carriers summary: Create or Update Batch CredCarrier description: 'Create or Update multiple CredCarrier at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredCarrier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredCarrier' text/json: schema: type: array items: $ref: '#/components/schemas/CredCarrier' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredCarrier' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-certifications: post: tags: - Credentialing Certifications summary: Create CredCertification description: Creates a new CredCertification operationId: CreateCredCertification parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredCertification' text/json: schema: $ref: '#/components/schemas/CredCertification' application/*+json: schema: $ref: '#/components/schemas/CredCertification' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredCertificationVBAResponse' application/json: schema: $ref: '#/components/schemas/CredCertificationVBAResponse' text/json: schema: $ref: '#/components/schemas/CredCertificationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Certifications summary: List CredCertification description: Lists all CredCertification operationId: ListCredCertification parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredCertificationListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredCertificationListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredCertificationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-certifications/{credCertificationKey}': get: tags: - Credentialing Certifications summary: Get CredCertification description: Gets CredCertification operationId: GetCredCertification parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credCertificationKey in: path description: CredCertification Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredCertificationVBAResponse' application/json: schema: $ref: '#/components/schemas/CredCertificationVBAResponse' text/json: schema: $ref: '#/components/schemas/CredCertificationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Certifications summary: Update CredCertification description: Updates a specific CredCertification. operationId: UpdateCredCertification parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credCertificationKey in: path description: CredCertification Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredCertification' text/json: schema: $ref: '#/components/schemas/CredCertification' application/*+json: schema: $ref: '#/components/schemas/CredCertification' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredCertificationVBAResponse' application/json: schema: $ref: '#/components/schemas/CredCertificationVBAResponse' text/json: schema: $ref: '#/components/schemas/CredCertificationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Certifications summary: Delete CredCertification description: Deletes an CredCertification operationId: DeleteCredCertification parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credCertificationKey in: path description: CredCertification Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-certifications-batch: put: tags: - Credentialing Certifications summary: Create or Update Batch CredCertification description: 'Create or Update multiple CredCertification at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredCertification parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredCertification' text/json: schema: type: array items: $ref: '#/components/schemas/CredCertification' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredCertification' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-confidentials: post: tags: - Credentialing Confidentials summary: Create CredConfidential description: Creates a new CredConfidential operationId: CreateCredConfidential parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredConfidential' text/json: schema: $ref: '#/components/schemas/CredConfidential' application/*+json: schema: $ref: '#/components/schemas/CredConfidential' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredConfidentialVBAResponse' application/json: schema: $ref: '#/components/schemas/CredConfidentialVBAResponse' text/json: schema: $ref: '#/components/schemas/CredConfidentialVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Confidentials summary: List CredConfidential description: Lists all CredConfidential operationId: ListCredConfidential parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredConfidentialListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredConfidentialListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredConfidentialListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-confidentials/{credConfidentialKey}': get: tags: - Credentialing Confidentials summary: Get CredConfidential description: Gets CredConfidential operationId: GetCredConfidential parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credConfidentialKey in: path description: CredConfidential Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredConfidentialVBAResponse' application/json: schema: $ref: '#/components/schemas/CredConfidentialVBAResponse' text/json: schema: $ref: '#/components/schemas/CredConfidentialVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Confidentials summary: Update CredConfidential description: Updates a specific CredConfidential. operationId: UpdateCredConfidential parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credConfidentialKey in: path description: CredConfidential Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredConfidential' text/json: schema: $ref: '#/components/schemas/CredConfidential' application/*+json: schema: $ref: '#/components/schemas/CredConfidential' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredConfidentialVBAResponse' application/json: schema: $ref: '#/components/schemas/CredConfidentialVBAResponse' text/json: schema: $ref: '#/components/schemas/CredConfidentialVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Confidentials summary: Delete CredConfidential description: Deletes an CredConfidential operationId: DeleteCredConfidential parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credConfidentialKey in: path description: CredConfidential Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-confidentials-batch: put: tags: - Credentialing Confidentials summary: Create or Update Batch CredConfidential description: 'Create or Update multiple CredConfidential at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredConfidential parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredConfidential' text/json: schema: type: array items: $ref: '#/components/schemas/CredConfidential' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredConfidential' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-contracts: post: tags: - Credentialing Contracts summary: Create CredContract description: Creates a new CredContract operationId: CreateCredContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredContract' text/json: schema: $ref: '#/components/schemas/CredContract' application/*+json: schema: $ref: '#/components/schemas/CredContract' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredContractVBAResponse' application/json: schema: $ref: '#/components/schemas/CredContractVBAResponse' text/json: schema: $ref: '#/components/schemas/CredContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Contracts summary: List CredContract description: Lists all CredContract operationId: ListCredContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredContractListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredContractListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredContractListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-contracts/{credContractKey}': get: tags: - Credentialing Contracts summary: Get CredContract description: Gets CredContract operationId: GetCredContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credContractKey in: path description: CredContract Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredContractVBAResponse' application/json: schema: $ref: '#/components/schemas/CredContractVBAResponse' text/json: schema: $ref: '#/components/schemas/CredContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Contracts summary: Update CredContract description: Updates a specific CredContract. operationId: UpdateCredContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credContractKey in: path description: CredContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredContract' text/json: schema: $ref: '#/components/schemas/CredContract' application/*+json: schema: $ref: '#/components/schemas/CredContract' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredContractVBAResponse' application/json: schema: $ref: '#/components/schemas/CredContractVBAResponse' text/json: schema: $ref: '#/components/schemas/CredContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Contracts summary: Delete CredContract description: Deletes an CredContract operationId: DeleteCredContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credContractKey in: path description: CredContract Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-contracts-batch: put: tags: - Credentialing Contracts summary: Create or Update Batch CredContract description: 'Create or Update multiple CredContract at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredContract' text/json: schema: type: array items: $ref: '#/components/schemas/CredContract' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredContract' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-dates: post: tags: - Credentialing Dates summary: Create CredDate description: Creates a new CredDate operationId: CreateCredDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredDate' text/json: schema: $ref: '#/components/schemas/CredDate' application/*+json: schema: $ref: '#/components/schemas/CredDate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredDateVBAResponse' application/json: schema: $ref: '#/components/schemas/CredDateVBAResponse' text/json: schema: $ref: '#/components/schemas/CredDateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Dates summary: List CredDate description: Lists all CredDate operationId: ListCredDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredDateListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredDateListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredDateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-dates/{credDateKey}': get: tags: - Credentialing Dates summary: Get CredDate description: Gets CredDate operationId: GetCredDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credDateKey in: path description: CredDate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredDateVBAResponse' application/json: schema: $ref: '#/components/schemas/CredDateVBAResponse' text/json: schema: $ref: '#/components/schemas/CredDateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Dates summary: Update CredDate description: Updates a specific CredDate. operationId: UpdateCredDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credDateKey in: path description: CredDate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredDate' text/json: schema: $ref: '#/components/schemas/CredDate' application/*+json: schema: $ref: '#/components/schemas/CredDate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredDateVBAResponse' application/json: schema: $ref: '#/components/schemas/CredDateVBAResponse' text/json: schema: $ref: '#/components/schemas/CredDateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Dates summary: Delete CredDate description: Deletes an CredDate operationId: DeleteCredDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credDateKey in: path description: CredDate Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-dates-batch: put: tags: - Credentialing Dates summary: Create or Update Batch CredDate description: 'Create or Update multiple CredDate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredDate' text/json: schema: type: array items: $ref: '#/components/schemas/CredDate' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredDate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-education-types: post: tags: - Credentialing Education Types summary: Create CredEducationType description: Creates a new CredEducationType operationId: CreateCredEducationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredEducationType' text/json: schema: $ref: '#/components/schemas/CredEducationType' application/*+json: schema: $ref: '#/components/schemas/CredEducationType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredEducationTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredEducationTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredEducationTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Education Types summary: List CredEducationType description: Lists all CredEducationType operationId: ListCredEducationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredEducationTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredEducationTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredEducationTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-education-types/{credEducationTypeKey}': get: tags: - Credentialing Education Types summary: Get CredEducationType description: Gets CredEducationType operationId: GetCredEducationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credEducationTypeKey in: path description: CredEducationType Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredEducationTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredEducationTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredEducationTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Education Types summary: Update CredEducationType description: Updates a specific CredEducationType. operationId: UpdateCredEducationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credEducationTypeKey in: path description: CredEducationType Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredEducationType' text/json: schema: $ref: '#/components/schemas/CredEducationType' application/*+json: schema: $ref: '#/components/schemas/CredEducationType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredEducationTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredEducationTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredEducationTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Education Types summary: Delete CredEducationType description: Deletes an CredEducationType operationId: DeleteCredEducationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credEducationTypeKey in: path description: CredEducationType Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-education-types-batch: put: tags: - Credentialing Education Types summary: Create or Update Batch CredEducationType description: 'Create or Update multiple CredEducationType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredEducationType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredEducationType' text/json: schema: type: array items: $ref: '#/components/schemas/CredEducationType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredEducationType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-license-types: post: tags: - Credentialing License Types summary: Create CredLicenseType description: Creates a new CredLicenseType operationId: CreateCredLicenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredLicenseType' text/json: schema: $ref: '#/components/schemas/CredLicenseType' application/*+json: schema: $ref: '#/components/schemas/CredLicenseType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredLicenseTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredLicenseTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredLicenseTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing License Types summary: List CredLicenseType description: Lists all CredLicenseType operationId: ListCredLicenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredLicenseTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredLicenseTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredLicenseTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-license-types/{credLicenseTypeKey}': get: tags: - Credentialing License Types summary: Get CredLicenseType description: Gets CredLicenseType operationId: GetCredLicenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credLicenseTypeKey in: path description: CredLicenseType Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredLicenseTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredLicenseTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredLicenseTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing License Types summary: Update CredLicenseType description: Updates a specific CredLicenseType. operationId: UpdateCredLicenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credLicenseTypeKey in: path description: CredLicenseType Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredLicenseType' text/json: schema: $ref: '#/components/schemas/CredLicenseType' application/*+json: schema: $ref: '#/components/schemas/CredLicenseType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredLicenseTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredLicenseTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredLicenseTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing License Types summary: Delete CredLicenseType description: Deletes an CredLicenseType operationId: DeleteCredLicenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credLicenseTypeKey in: path description: CredLicenseType Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-license-types-batch: put: tags: - Credentialing License Types summary: Create or Update Batch CredLicenseType description: 'Create or Update multiple CredLicenseType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredLicenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredLicenseType' text/json: schema: type: array items: $ref: '#/components/schemas/CredLicenseType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredLicenseType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-options: post: tags: - Credentialing Options summary: Create CredOption description: Creates a new CredOption operationId: CreateCredOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredOption' text/json: schema: $ref: '#/components/schemas/CredOption' application/*+json: schema: $ref: '#/components/schemas/CredOption' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/CredOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/CredOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Options summary: List CredOption description: Lists all CredOption operationId: ListCredOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-options/{credOptionKey}': get: tags: - Credentialing Options summary: Get CredOption description: Gets CredOption operationId: GetCredOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credOptionKey in: path description: CredOption Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/CredOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/CredOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Options summary: Update CredOption description: Updates a specific CredOption. operationId: UpdateCredOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credOptionKey in: path description: CredOption Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredOption' text/json: schema: $ref: '#/components/schemas/CredOption' application/*+json: schema: $ref: '#/components/schemas/CredOption' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/CredOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/CredOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Options summary: Delete CredOption description: Deletes an CredOption operationId: DeleteCredOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credOptionKey in: path description: CredOption Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-options-batch: put: tags: - Credentialing Options summary: Create or Update Batch CredOption description: 'Create or Update multiple CredOption at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredOption' text/json: schema: type: array items: $ref: '#/components/schemas/CredOption' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredOption' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-practice-categories: post: tags: - Credentialing Practice Categories summary: Create CredPracticeCategory description: Creates a new CredPracticeCategory operationId: CreateCredPracticeCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredPracticeCategory' text/json: schema: $ref: '#/components/schemas/CredPracticeCategory' application/*+json: schema: $ref: '#/components/schemas/CredPracticeCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredPracticeCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CredPracticeCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CredPracticeCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Practice Categories summary: List CredPracticeCategory description: Lists all CredPracticeCategory operationId: ListCredPracticeCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredPracticeCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredPracticeCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredPracticeCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-practice-categories/{credPracticeCategoryKey}': get: tags: - Credentialing Practice Categories summary: Get CredPracticeCategory description: Gets CredPracticeCategory operationId: GetCredPracticeCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credPracticeCategoryKey in: path description: CredPracticeCategory Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredPracticeCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CredPracticeCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CredPracticeCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Practice Categories summary: Update CredPracticeCategory description: Updates a specific CredPracticeCategory. operationId: UpdateCredPracticeCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credPracticeCategoryKey in: path description: CredPracticeCategory Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredPracticeCategory' text/json: schema: $ref: '#/components/schemas/CredPracticeCategory' application/*+json: schema: $ref: '#/components/schemas/CredPracticeCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredPracticeCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/CredPracticeCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/CredPracticeCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Practice Categories summary: Delete CredPracticeCategory description: Deletes an CredPracticeCategory operationId: DeleteCredPracticeCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credPracticeCategoryKey in: path description: CredPracticeCategory Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-practice-categories-batch: put: tags: - Credentialing Practice Categories summary: Create or Update Batch CredPracticeCategory description: 'Create or Update multiple CredPracticeCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredPracticeCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredPracticeCategory' text/json: schema: type: array items: $ref: '#/components/schemas/CredPracticeCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredPracticeCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-practice-categories/{credPracticeCategoryKey}/practice-types': post: tags: - Credentialing Practice Category Types summary: Create CredPracticeType description: Creates a new CredPracticeType operationId: CreateCredPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credPracticeCategoryKey in: path description: CredPracticeCategory Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredPracticeType' text/json: schema: $ref: '#/components/schemas/CredPracticeType' application/*+json: schema: $ref: '#/components/schemas/CredPracticeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredPracticeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredPracticeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredPracticeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Practice Category Types summary: List CredPracticeType description: Lists all CredPracticeType for the given credPracticeCategoryKey operationId: ListCredPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credPracticeCategoryKey in: path description: CredPracticeCategory Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredPracticeTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredPracticeTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredPracticeTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-practice-categories/{credPracticeCategoryKey}/practice-types/{credPracticeTypeKey}': get: tags: - Credentialing Practice Category Types summary: Get CredPracticeType description: Gets CredPracticeType operationId: GetCredPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credPracticeCategoryKey in: path description: CredPracticeCategory Key required: true schema: type: integer format: int32 - name: credPracticeTypeKey in: path description: CredPracticeType Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredPracticeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredPracticeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredPracticeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Practice Category Types summary: Update CredPracticeType description: Updates a specific CredPracticeType. operationId: UpdateCredPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credPracticeCategoryKey in: path description: CredPracticeCategory Key required: true schema: type: integer format: int32 - name: credPracticeTypeKey in: path description: CredPracticeType Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredPracticeType' text/json: schema: $ref: '#/components/schemas/CredPracticeType' application/*+json: schema: $ref: '#/components/schemas/CredPracticeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredPracticeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredPracticeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredPracticeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Practice Category Types summary: Delete CredPracticeType description: Deletes an CredPracticeType operationId: DeleteCredPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credPracticeCategoryKey in: path description: CredPracticeCategory Key required: true schema: type: integer format: int32 - name: credPracticeTypeKey in: path description: CredPracticeType Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-practice-categories/{credPracticeCategoryKey}/practice-types-batch': put: tags: - Credentialing Practice Category Types summary: Create or Update Batch CredPracticeType description: 'Create or Update multiple CredPracticeType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credPracticeCategoryKey in: path description: CredPracticeCategory Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredPracticeType' text/json: schema: type: array items: $ref: '#/components/schemas/CredPracticeType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredPracticeType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-qualities: post: tags: - Credentialing Quality summary: Create CredQuality description: Creates a new CredQuality operationId: CreateCredQuality parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredQuality' text/json: schema: $ref: '#/components/schemas/CredQuality' application/*+json: schema: $ref: '#/components/schemas/CredQuality' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredQualityVBAResponse' application/json: schema: $ref: '#/components/schemas/CredQualityVBAResponse' text/json: schema: $ref: '#/components/schemas/CredQualityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Quality summary: List CredQuality description: Lists all CredQuality operationId: ListCredQuality parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredQualityListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredQualityListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredQualityListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-qualities/{credQualityKey}': get: tags: - Credentialing Quality summary: Get CredQuality description: Gets CredQuality operationId: GetCredQuality parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credQualityKey in: path description: CredQuality Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredQualityVBAResponse' application/json: schema: $ref: '#/components/schemas/CredQualityVBAResponse' text/json: schema: $ref: '#/components/schemas/CredQualityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Quality summary: Update CredQuality description: Updates a specific CredQuality. operationId: UpdateCredQuality parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credQualityKey in: path description: CredQuality Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredQuality' text/json: schema: $ref: '#/components/schemas/CredQuality' application/*+json: schema: $ref: '#/components/schemas/CredQuality' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredQualityVBAResponse' application/json: schema: $ref: '#/components/schemas/CredQualityVBAResponse' text/json: schema: $ref: '#/components/schemas/CredQualityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Quality summary: Delete CredQuality description: Deletes an CredQuality operationId: DeleteCredQuality parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credQualityKey in: path description: CredQuality Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-qualities-batch: put: tags: - Credentialing Quality summary: Create or Update Batch CredQuality description: 'Create or Update multiple CredQuality at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredQuality parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredQuality' text/json: schema: type: array items: $ref: '#/components/schemas/CredQuality' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredQuality' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-services: post: tags: - Credentialing Services summary: Create CredService description: Creates a new CredService operationId: CreateCredService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredService' text/json: schema: $ref: '#/components/schemas/CredService' application/*+json: schema: $ref: '#/components/schemas/CredService' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredServiceVBAResponse' application/json: schema: $ref: '#/components/schemas/CredServiceVBAResponse' text/json: schema: $ref: '#/components/schemas/CredServiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Services summary: List CredService description: Lists all CredService operationId: ListCredService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredServiceListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredServiceListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredServiceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-services/{credServiceKey}': get: tags: - Credentialing Services summary: Get CredService description: Gets CredService operationId: GetCredService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credServiceKey in: path description: CredService Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredServiceVBAResponse' application/json: schema: $ref: '#/components/schemas/CredServiceVBAResponse' text/json: schema: $ref: '#/components/schemas/CredServiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Services summary: Update CredService description: Updates a specific CredService. operationId: UpdateCredService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credServiceKey in: path description: CredService Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredService' text/json: schema: $ref: '#/components/schemas/CredService' application/*+json: schema: $ref: '#/components/schemas/CredService' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredServiceVBAResponse' application/json: schema: $ref: '#/components/schemas/CredServiceVBAResponse' text/json: schema: $ref: '#/components/schemas/CredServiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Services summary: Delete CredService description: Deletes an CredService operationId: DeleteCredService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credServiceKey in: path description: CredService Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-services-batch: put: tags: - Credentialing Services summary: Create or Update Batch CredService description: 'Create or Update multiple CredService at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredService' text/json: schema: type: array items: $ref: '#/components/schemas/CredService' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredService' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-statuses: post: tags: - Credentialing Statuses summary: Create CredStatus description: Creates a new CredStatus operationId: CreateCredStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredStatus' text/json: schema: $ref: '#/components/schemas/CredStatus' application/*+json: schema: $ref: '#/components/schemas/CredStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CredStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CredStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Statuses summary: List CredStatus description: Lists all CredStatus operationId: ListCredStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-statuses/{credStatus}': get: tags: - Credentialing Statuses summary: Get CredStatus description: Gets CredStatus operationId: GetCredStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credStatus in: path description: Cred Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CredStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CredStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Statuses summary: Update CredStatus description: Updates a specific CredStatus. operationId: UpdateCredStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credStatus in: path description: Cred Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredStatus' text/json: schema: $ref: '#/components/schemas/CredStatus' application/*+json: schema: $ref: '#/components/schemas/CredStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/CredStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/CredStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Statuses summary: Delete CredStatus description: Deletes an CredStatus operationId: DeleteCredStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credStatus in: path description: Cred Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-statuses-batch: put: tags: - Credentialing Statuses summary: Create or Update Batch CredStatus description: 'Create or Update multiple CredStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredStatus' text/json: schema: type: array items: $ref: '#/components/schemas/CredStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-techniques: post: tags: - Credentialing Techniques summary: Create CredTechnique description: Creates a new CredTechnique operationId: CreateCredTechnique parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredTechnique' text/json: schema: $ref: '#/components/schemas/CredTechnique' application/*+json: schema: $ref: '#/components/schemas/CredTechnique' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredTechniqueVBAResponse' application/json: schema: $ref: '#/components/schemas/CredTechniqueVBAResponse' text/json: schema: $ref: '#/components/schemas/CredTechniqueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Techniques summary: List CredTechnique description: Lists all CredTechnique operationId: ListCredTechnique parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredTechniqueListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredTechniqueListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredTechniqueListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-techniques/{credTechniqueKey}': get: tags: - Credentialing Techniques summary: Get CredTechnique description: Gets CredTechnique operationId: GetCredTechnique parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credTechniqueKey in: path description: CredTechnique Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredTechniqueVBAResponse' application/json: schema: $ref: '#/components/schemas/CredTechniqueVBAResponse' text/json: schema: $ref: '#/components/schemas/CredTechniqueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Techniques summary: Update CredTechnique description: Updates a specific CredTechnique. operationId: UpdateCredTechnique parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credTechniqueKey in: path description: CredTechnique Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredTechnique' text/json: schema: $ref: '#/components/schemas/CredTechnique' application/*+json: schema: $ref: '#/components/schemas/CredTechnique' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredTechniqueVBAResponse' application/json: schema: $ref: '#/components/schemas/CredTechniqueVBAResponse' text/json: schema: $ref: '#/components/schemas/CredTechniqueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Techniques summary: Delete CredTechnique description: Deletes an CredTechnique operationId: DeleteCredTechnique parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credTechniqueKey in: path description: CredTechnique Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-techniques-batch: put: tags: - Credentialing Techniques summary: Create or Update Batch CredTechnique description: 'Create or Update multiple CredTechnique at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredTechnique parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredTechnique' text/json: schema: type: array items: $ref: '#/components/schemas/CredTechnique' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredTechnique' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-terminations: post: tags: - Credentialing Terminations summary: Create CredTermination description: Creates a new CredTermination operationId: CreateCredTermination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredTermination' text/json: schema: $ref: '#/components/schemas/CredTermination' application/*+json: schema: $ref: '#/components/schemas/CredTermination' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredTerminationVBAResponse' application/json: schema: $ref: '#/components/schemas/CredTerminationVBAResponse' text/json: schema: $ref: '#/components/schemas/CredTerminationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Terminations summary: List CredTermination description: Lists all CredTermination operationId: ListCredTermination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredTerminationListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredTerminationListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredTerminationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-terminations/{credTerminationKey}': get: tags: - Credentialing Terminations summary: Get CredTermination description: Gets CredTermination operationId: GetCredTermination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credTerminationKey in: path description: CredTermination Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredTerminationVBAResponse' application/json: schema: $ref: '#/components/schemas/CredTerminationVBAResponse' text/json: schema: $ref: '#/components/schemas/CredTerminationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Terminations summary: Update CredTermination description: Updates a specific CredTermination. operationId: UpdateCredTermination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credTerminationKey in: path description: CredTermination Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredTermination' text/json: schema: $ref: '#/components/schemas/CredTermination' application/*+json: schema: $ref: '#/components/schemas/CredTermination' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredTerminationVBAResponse' application/json: schema: $ref: '#/components/schemas/CredTerminationVBAResponse' text/json: schema: $ref: '#/components/schemas/CredTerminationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Terminations summary: Delete CredTermination description: Deletes an CredTermination operationId: DeleteCredTermination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credTerminationKey in: path description: CredTermination Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-terminations-batch: put: tags: - Credentialing Terminations summary: Create or Update Batch CredTermination description: 'Create or Update multiple CredTermination at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredTermination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredTermination' text/json: schema: type: array items: $ref: '#/components/schemas/CredTermination' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredTermination' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-types: post: tags: - Credentialing Types summary: Create CredType description: Creates a new CredType operationId: CreateCredType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CredType' text/json: schema: $ref: '#/components/schemas/CredType' application/*+json: schema: $ref: '#/components/schemas/CredType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Credentialing Types summary: List CredType description: Lists all CredType operationId: ListCredType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/CredTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/CredTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/credentialing-types/{credTypeKey}': get: tags: - Credentialing Types summary: Get CredType description: Gets CredType operationId: GetCredType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credTypeKey in: path description: CredType Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Credentialing Types summary: Update CredType description: Updates a specific CredType. operationId: UpdateCredType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credTypeKey in: path description: CredType Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CredType' text/json: schema: $ref: '#/components/schemas/CredType' application/*+json: schema: $ref: '#/components/schemas/CredType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CredTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/CredTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/CredTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Credentialing Types summary: Delete CredType description: Deletes an CredType operationId: DeleteCredType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: credTypeKey in: path description: CredType Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /credentialing-types-batch: put: tags: - Credentialing Types summary: Create or Update Batch CredType description: 'Create or Update multiple CredType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCredType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CredType' text/json: schema: type: array items: $ref: '#/components/schemas/CredType' application/*+json: schema: type: array items: $ref: '#/components/schemas/CredType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /criterias: post: tags: - Search Criteria - Criteria summary: Create a search Criteria description: Creates a new search Criteria. operationId: CreateCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Criteria' text/json: schema: $ref: '#/components/schemas/Criteria' application/*+json: schema: $ref: '#/components/schemas/Criteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/CriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/CriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Search Criteria - Criteria summary: List Criteria description: 'List Criteria. Optional ' operationId: ListCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: searchConfigId in: query description: Search Config Id schema: type: string - name: criteriaUser in: query description: Criteria User schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CriteriaListVBAResponse' application/json: schema: $ref: '#/components/schemas/CriteriaListVBAResponse' text/json: schema: $ref: '#/components/schemas/CriteriaListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/criterias/{criteriaKey}': get: tags: - Search Criteria - Criteria summary: Get Criteria description: Gets Criteria operationId: GetCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: criteriaKey in: path description: Criteria Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/CriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/CriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Search Criteria - Criteria summary: Update Criteria description: Updates a specific Criteria. operationId: UpdateCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: criteriaKey in: path description: Criteria Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Criteria' text/json: schema: $ref: '#/components/schemas/Criteria' application/*+json: schema: $ref: '#/components/schemas/Criteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/CriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/CriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Search Criteria - Criteria summary: Delete Criteria description: Deletes a Criteria operationId: DeleteCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: criteriaKey in: path description: Criteria Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /criterias-batch: put: tags: - Search Criteria - Criteria summary: Create or Update Batch Criteria description: Creates or Updates multiple Criteria. operationId: CreateOrUpdateBatchCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Criteria' text/json: schema: type: array items: $ref: '#/components/schemas/Criteria' application/*+json: schema: type: array items: $ref: '#/components/schemas/Criteria' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/criterias-where-clause/{criteriaKey}': get: tags: - Criteria summary: Get this Criteria Where Clause description: Helper function to take an existing list of Criteria Detail and merge it all together into a single WHERE Clause to be used with other services. operationId: GetCriteriaWhereClause parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: criteriaKey in: path description: Criteria Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /currencies: post: tags: - Currency summary: Create Currency description: Creates a new Currency operationId: CreateCurrency parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Currency' text/json: schema: $ref: '#/components/schemas/Currency' application/*+json: schema: $ref: '#/components/schemas/Currency' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CurrencyVBAResponse' application/json: schema: $ref: '#/components/schemas/CurrencyVBAResponse' text/json: schema: $ref: '#/components/schemas/CurrencyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Currency summary: List Currency description: 'Lists all Currency ' operationId: ListCurrency parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CurrencyListVBAResponse' application/json: schema: $ref: '#/components/schemas/CurrencyListVBAResponse' text/json: schema: $ref: '#/components/schemas/CurrencyListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/currencies/{currencyID}': get: tags: - Currency summary: Get Currency description: Gets Currency operationId: GetCurrency parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: currencyID in: path description: Currency ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CurrencyVBAResponse' application/json: schema: $ref: '#/components/schemas/CurrencyVBAResponse' text/json: schema: $ref: '#/components/schemas/CurrencyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Currency summary: Update Currency description: Updates a specific Currency. operationId: UpdateCurrency parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: currencyID in: path description: Currency ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Currency' text/json: schema: $ref: '#/components/schemas/Currency' application/*+json: schema: $ref: '#/components/schemas/Currency' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/CurrencyVBAResponse' application/json: schema: $ref: '#/components/schemas/CurrencyVBAResponse' text/json: schema: $ref: '#/components/schemas/CurrencyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Currency summary: Delete Currency description: Deletes an Currency operationId: DeleteCurrency parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: currencyID in: path description: Currency ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /currencies-batch: put: tags: - Currency summary: Create or Update Batch Currency description: 'Create or Update multiple Currency at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchCurrency parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Currency' text/json: schema: type: array items: $ref: '#/components/schemas/Currency' application/*+json: schema: type: array items: $ref: '#/components/schemas/Currency' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /day-intervals: post: tags: - Day Intervals summary: Create DayInterval description: Creates a new DayInterval operationId: CreateDayInterval parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DayInterval' text/json: schema: $ref: '#/components/schemas/DayInterval' application/*+json: schema: $ref: '#/components/schemas/DayInterval' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DayIntervalVBAResponse' application/json: schema: $ref: '#/components/schemas/DayIntervalVBAResponse' text/json: schema: $ref: '#/components/schemas/DayIntervalVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Day Intervals summary: List DayInterval description: Lists all DayInterval operationId: ListDayInterval parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DayIntervalListVBAResponse' application/json: schema: $ref: '#/components/schemas/DayIntervalListVBAResponse' text/json: schema: $ref: '#/components/schemas/DayIntervalListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/day-intervals/{intervalYear}/{intervalMonth}/{intervalDay}': get: tags: - Day Intervals summary: Get DayInterval description: Gets DayInterval operationId: GetDayInterval parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: intervalYear in: path description: Interval Year required: true schema: type: integer format: int32 - name: intervalMonth in: path description: Interval Month required: true schema: type: integer format: int32 - name: intervalDay in: path description: Interval Day required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DayIntervalVBAResponse' application/json: schema: $ref: '#/components/schemas/DayIntervalVBAResponse' text/json: schema: $ref: '#/components/schemas/DayIntervalVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Day Intervals summary: Update DayInterval description: Updates a specific DayInterval. operationId: UpdateDayInterval parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: intervalYear in: path description: Interval Year required: true schema: type: integer format: int32 - name: intervalMonth in: path description: Interval Month required: true schema: type: integer format: int32 - name: intervalDay in: path description: Interval Day required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DayInterval' text/json: schema: $ref: '#/components/schemas/DayInterval' application/*+json: schema: $ref: '#/components/schemas/DayInterval' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DayIntervalVBAResponse' application/json: schema: $ref: '#/components/schemas/DayIntervalVBAResponse' text/json: schema: $ref: '#/components/schemas/DayIntervalVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Day Intervals summary: Delete DayInterval description: Deletes an DayInterval operationId: DeleteDayInterval parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: intervalYear in: path description: Interval Year required: true schema: type: integer format: int32 - name: intervalMonth in: path description: Interval Month required: true schema: type: integer format: int32 - name: intervalDay in: path description: Interval Day required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /day-intervals-batch: put: tags: - Day Intervals summary: Create or Update Batch DayInterval description: 'Create or Update multiple DayInterval at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDayInterval parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DayInterval' text/json: schema: type: array items: $ref: '#/components/schemas/DayInterval' application/*+json: schema: type: array items: $ref: '#/components/schemas/DayInterval' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /diagnostic-codes: post: tags: - Diagnostic Codes summary: Create DiagnosticCode description: Creates a new DiagnosticCode operationId: CreateDiagnosticCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DiagnosticCode' text/json: schema: $ref: '#/components/schemas/DiagnosticCode' application/*+json: schema: $ref: '#/components/schemas/DiagnosticCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DiagnosticCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/DiagnosticCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Diagnostic Codes summary: List DiagnosticCode description: Lists all DiagnosticCode operationId: ListDiagnosticCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DiagnosticCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/DiagnosticCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/diagnostic-codes/{diagnosticCode}/{diagnosticCodeType}/{effectiveDate}': get: tags: - Diagnostic Codes summary: Get DiagnosticCode description: Gets DiagnosticCode operationId: GetDiagnosticCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: diagnosticCode in: path description: Diagnostic Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DiagnosticCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/DiagnosticCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Diagnostic Codes summary: Update DiagnosticCode description: Updates a specific DiagnosticCode. operationId: UpdateDiagnosticCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: diagnosticCode in: path description: Diagnostic Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/DiagnosticCode' text/json: schema: $ref: '#/components/schemas/DiagnosticCode' application/*+json: schema: $ref: '#/components/schemas/DiagnosticCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DiagnosticCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/DiagnosticCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Diagnostic Codes summary: Delete DiagnosticCode description: Deletes an DiagnosticCode operationId: DeleteDiagnosticCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: diagnosticCode in: path description: Diagnostic Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/diagnostic-codes/{diagnosticCode}/{diagnosticCodeType}/current-diag': get: tags: - Diagnostic Codes summary: Get The Most Recent DiagnosticCode description: Gets The Most Recent DiagnosticCode operationId: GetCurrentDiagnosticCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: diagnosticCode in: path description: Diagnostic Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DiagnosticCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/DiagnosticCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /diagnostic-codes-batch: put: tags: - Diagnostic Codes summary: Create or Update Batch DiagnosticCode description: 'Create or Update multiple DiagnosticCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDiagnosticCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DiagnosticCode' text/json: schema: type: array items: $ref: '#/components/schemas/DiagnosticCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/DiagnosticCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /diagnostic-code-groups: post: tags: - Diagnostic Code Groups summary: Create DiagnosticCodeGroup description: Creates a new DiagnosticCodeGroup operationId: CreateDiagnosticCodeGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DiagnosticCodeGroup' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeGroup' application/*+json: schema: $ref: '#/components/schemas/DiagnosticCodeGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DiagnosticCodeGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/DiagnosticCodeGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Diagnostic Code Groups summary: List DiagnosticCodeGroup description: Lists all DiagnosticCodeGroup operationId: ListDiagnosticCodeGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DiagnosticCodeGroupListVBAResponse' application/json: schema: $ref: '#/components/schemas/DiagnosticCodeGroupListVBAResponse' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeGroupListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/diagnostic-code-groups/{diagnosticGroup}': get: tags: - Diagnostic Code Groups summary: Get DiagnosticCodeGroup description: Gets DiagnosticCodeGroup operationId: GetDiagnosticCodeGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: diagnosticGroup in: path description: Diagnostic Group required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DiagnosticCodeGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/DiagnosticCodeGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Diagnostic Code Groups summary: Update DiagnosticCodeGroup description: Updates a specific DiagnosticCodeGroup. operationId: UpdateDiagnosticCodeGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: diagnosticGroup in: path description: Diagnostic Group required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DiagnosticCodeGroup' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeGroup' application/*+json: schema: $ref: '#/components/schemas/DiagnosticCodeGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DiagnosticCodeGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/DiagnosticCodeGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Diagnostic Code Groups summary: Delete DiagnosticCodeGroup description: Deletes an DiagnosticCodeGroup operationId: DeleteDiagnosticCodeGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: diagnosticGroup in: path description: Diagnostic Group required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /diagnostic-code-groups-batch: put: tags: - Diagnostic Code Groups summary: Create or Update Batch DiagnosticCodeGroup description: 'Create or Update multiple DiagnosticCodeGroup at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDiagnosticCodeGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DiagnosticCodeGroup' text/json: schema: type: array items: $ref: '#/components/schemas/DiagnosticCodeGroup' application/*+json: schema: type: array items: $ref: '#/components/schemas/DiagnosticCodeGroup' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /diagnostic-code-types: post: tags: - Diagnostic Code Types summary: Create DiagnosticCodeType description: Creates a new DiagnosticCodeType operationId: CreateDiagnosticCodeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DiagnosticCodeType' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeType' application/*+json: schema: $ref: '#/components/schemas/DiagnosticCodeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DiagnosticCodeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/DiagnosticCodeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Diagnostic Code Types summary: List DiagnosticCodeType description: Lists all DiagnosticCodeType operationId: ListDiagnosticCodeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DiagnosticCodeTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/DiagnosticCodeTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/diagnostic-code-types/{diagnosticCodeType}': get: tags: - Diagnostic Code Types summary: Get DiagnosticCodeType description: Gets DiagnosticCodeType operationId: GetDiagnosticCodeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DiagnosticCodeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/DiagnosticCodeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Diagnostic Code Types summary: Update DiagnosticCodeType description: Updates a specific DiagnosticCodeType. operationId: UpdateDiagnosticCodeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DiagnosticCodeType' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeType' application/*+json: schema: $ref: '#/components/schemas/DiagnosticCodeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DiagnosticCodeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/DiagnosticCodeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/DiagnosticCodeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Diagnostic Code Types summary: Delete DiagnosticCodeType description: Deletes an DiagnosticCodeType operationId: DeleteDiagnosticCodeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /diagnostic-code-types-batch: put: tags: - Diagnostic Code Types summary: Create or Update Batch DiagnosticCodeType description: 'Create or Update multiple DiagnosticCodeType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDiagnosticCodeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DiagnosticCodeType' text/json: schema: type: array items: $ref: '#/components/schemas/DiagnosticCodeType' application/*+json: schema: type: array items: $ref: '#/components/schemas/DiagnosticCodeType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disability-event-case-changes: post: tags: - Disability Event Case Changes summary: Create DisabilityEventCaseChanged description: Creates a new DisabilityEventCaseChanged operationId: CreateDisabilityEventCaseChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisabilityEventCaseChanged' text/json: schema: $ref: '#/components/schemas/DisabilityEventCaseChanged' application/*+json: schema: $ref: '#/components/schemas/DisabilityEventCaseChanged' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventCaseChangedVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventCaseChangedVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventCaseChangedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Disability Event Case Changes summary: List DisabilityEventCaseChanged description: Lists all DisabilityEventCaseChanged operationId: ListDisabilityEventCaseChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventCaseChangedListVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventCaseChangedListVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventCaseChangedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/disability-event-case-changes/{DisabilityEventCaseChanged_Key}': get: tags: - Disability Event Case Changes summary: Get DisabilityEventCaseChanged description: Gets DisabilityEventCaseChanged operationId: GetDisabilityEventCaseChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisabilityEventCaseChanged_Key in: path description: DisabilityEventCaseChanged Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventCaseChangedVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventCaseChangedVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventCaseChangedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Disability Event Case Changes summary: Update DisabilityEventCaseChanged description: Updates a specific DisabilityEventCaseChanged. operationId: UpdateDisabilityEventCaseChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisabilityEventCaseChanged_Key in: path description: DisabilityEventCaseChanged Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DisabilityEventCaseChanged' text/json: schema: $ref: '#/components/schemas/DisabilityEventCaseChanged' application/*+json: schema: $ref: '#/components/schemas/DisabilityEventCaseChanged' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventCaseChangedVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventCaseChangedVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventCaseChangedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Disability Event Case Changes summary: Delete DisabilityEventCaseChanged description: Deletes an DisabilityEventCaseChanged operationId: DeleteDisabilityEventCaseChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisabilityEventCaseChanged_Key in: path description: DisabilityEventCaseChanged Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disability-event-case-changes-batch: put: tags: - Disability Event Case Changes summary: Create or Update Batch DisabilityEventCaseChanged description: 'Create or Update multiple DisabilityEventCaseChanged at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDisabilityEventCaseChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventCaseChanged' text/json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventCaseChanged' application/*+json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventCaseChanged' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disability-event-deduction-changes: post: tags: - Disability Event Deduction Changes summary: Create DisabilityEventDeductionChanged description: Creates a new DisabilityEventDeductionChanged operationId: CreateDisabilityEventDeductionChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChanged' text/json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChanged' application/*+json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChanged' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventDeductionChangedVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChangedVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChangedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Disability Event Deduction Changes summary: List DisabilityEventDeductionChanged description: Lists all DisabilityEventDeductionChanged operationId: ListDisabilityEventDeductionChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventDeductionChangedListVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChangedListVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChangedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/disability-event-deduction-changes/{DisabilityEventDeductionChanged_Key}': get: tags: - Disability Event Deduction Changes summary: Get DisabilityEventDeductionChanged description: Gets DisabilityEventDeductionChanged operationId: GetDisabilityEventDeductionChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisabilityEventDeductionChanged_Key in: path description: DisabilityEventDeductionChanged Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventDeductionChangedVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChangedVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChangedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Disability Event Deduction Changes summary: Update DisabilityEventDeductionChanged description: Updates a specific DisabilityEventDeductionChanged. operationId: UpdateDisabilityEventDeductionChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisabilityEventDeductionChanged_Key in: path description: DisabilityEventDeductionChanged Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChanged' text/json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChanged' application/*+json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChanged' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventDeductionChangedVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChangedVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventDeductionChangedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Disability Event Deduction Changes summary: Delete DisabilityEventDeductionChanged description: Deletes an DisabilityEventDeductionChanged operationId: DeleteDisabilityEventDeductionChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisabilityEventDeductionChanged_Key in: path description: DisabilityEventDeductionChanged Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disability-event-deduction-changes-batch: put: tags: - Disability Event Deduction Changes summary: Create or Update Batch DisabilityEventDeductionChanged description: 'Create or Update multiple DisabilityEventDeductionChanged at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDisabilityEventDeductionChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventDeductionChanged' text/json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventDeductionChanged' application/*+json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventDeductionChanged' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disability-event-fields: post: tags: - Disability Event Fields summary: Create DisabilityEventField description: Creates a new DisabilityEventField operationId: CreateDisabilityEventField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisabilityEventField' text/json: schema: $ref: '#/components/schemas/DisabilityEventField' application/*+json: schema: $ref: '#/components/schemas/DisabilityEventField' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventFieldVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventFieldVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventFieldVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Disability Event Fields summary: List DisabilityEventField description: Lists all DisabilityEventField operationId: ListDisabilityEventField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventFieldListVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventFieldListVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventFieldListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/disability-event-fields/{Field_Name}': get: tags: - Disability Event Fields summary: Get DisabilityEventField description: Gets DisabilityEventField operationId: GetDisabilityEventField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Field_Name in: path description: Field Name required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventFieldVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventFieldVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventFieldVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Disability Event Fields summary: Update DisabilityEventField description: Updates a specific DisabilityEventField. operationId: UpdateDisabilityEventField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Field_Name in: path description: Field Name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisabilityEventField' text/json: schema: $ref: '#/components/schemas/DisabilityEventField' application/*+json: schema: $ref: '#/components/schemas/DisabilityEventField' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventFieldVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventFieldVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventFieldVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Disability Event Fields summary: Delete DisabilityEventField description: Deletes an DisabilityEventField operationId: DeleteDisabilityEventField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Field_Name in: path description: Field Name required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disability-event-fields-batch: put: tags: - Disability Event Fields summary: Create or Update Batch DisabilityEventField description: 'Create or Update multiple DisabilityEventField at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDisabilityEventField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventField' text/json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventField' application/*+json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventField' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disability-event-field-changes: post: tags: - Disability Event Field Changes summary: Create DisabilityEventFieldChanged description: Creates a new DisabilityEventFieldChanged operationId: CreateDisabilityEventFieldChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisabilityEventFieldChanged' text/json: schema: $ref: '#/components/schemas/DisabilityEventFieldChanged' application/*+json: schema: $ref: '#/components/schemas/DisabilityEventFieldChanged' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventFieldChangedVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventFieldChangedVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventFieldChangedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Disability Event Field Changes summary: List DisabilityEventFieldChanged description: Lists all DisabilityEventFieldChanged operationId: ListDisabilityEventFieldChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventFieldChangedListVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventFieldChangedListVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventFieldChangedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/disability-event-field-changes/{DisabilityEventFieldChanged_Key}': get: tags: - Disability Event Field Changes summary: Get DisabilityEventFieldChanged description: Gets DisabilityEventFieldChanged operationId: GetDisabilityEventFieldChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisabilityEventFieldChanged_Key in: path description: DisabilityEventFieldChanged Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventFieldChangedVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventFieldChangedVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventFieldChangedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Disability Event Field Changes summary: Update DisabilityEventFieldChanged description: Updates a specific DisabilityEventFieldChanged. operationId: UpdateDisabilityEventFieldChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisabilityEventFieldChanged_Key in: path description: DisabilityEventFieldChanged Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DisabilityEventFieldChanged' text/json: schema: $ref: '#/components/schemas/DisabilityEventFieldChanged' application/*+json: schema: $ref: '#/components/schemas/DisabilityEventFieldChanged' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventFieldChangedVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventFieldChangedVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventFieldChangedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Disability Event Field Changes summary: Delete DisabilityEventFieldChanged description: Deletes an DisabilityEventFieldChanged operationId: DeleteDisabilityEventFieldChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisabilityEventFieldChanged_Key in: path description: DisabilityEventFieldChanged Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disability-event-field-changes-batch: put: tags: - Disability Event Field Changes summary: Create or Update Batch DisabilityEventFieldChanged description: 'Create or Update multiple DisabilityEventFieldChanged at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDisabilityEventFieldChanged parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventFieldChanged' text/json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventFieldChanged' application/*+json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventFieldChanged' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disability-event-groups: post: tags: - Disability Event Groups summary: Create DisabilityEventGroup description: Creates a new DisabilityEventGroup operationId: CreateDisabilityEventGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisabilityEventGroup' text/json: schema: $ref: '#/components/schemas/DisabilityEventGroup' application/*+json: schema: $ref: '#/components/schemas/DisabilityEventGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Disability Event Groups summary: List DisabilityEventGroup description: Lists all DisabilityEventGroup operationId: ListDisabilityEventGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventGroupListVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventGroupListVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventGroupListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/disability-event-groups/{DisabilityEventGroup_Key}': get: tags: - Disability Event Groups summary: Get DisabilityEventGroup description: Gets DisabilityEventGroup operationId: GetDisabilityEventGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisabilityEventGroup_Key in: path description: DisabilityEventGroup Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Disability Event Groups summary: Update DisabilityEventGroup description: Updates a specific DisabilityEventGroup. operationId: UpdateDisabilityEventGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisabilityEventGroup_Key in: path description: DisabilityEventGroup Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DisabilityEventGroup' text/json: schema: $ref: '#/components/schemas/DisabilityEventGroup' application/*+json: schema: $ref: '#/components/schemas/DisabilityEventGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityEventGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityEventGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityEventGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Disability Event Groups summary: Delete DisabilityEventGroup description: Deletes an DisabilityEventGroup operationId: DeleteDisabilityEventGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisabilityEventGroup_Key in: path description: DisabilityEventGroup Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disability-event-groups-batch: put: tags: - Disability Event Groups summary: Create or Update Batch DisabilityEventGroup description: 'Create or Update multiple DisabilityEventGroup at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDisabilityEventGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventGroup' text/json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventGroup' application/*+json: schema: type: array items: $ref: '#/components/schemas/DisabilityEventGroup' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/disability-limits': post: tags: - Plan Disability Limits summary: Create DisabilityPlanLimit description: Creates a new DisabilityPlanLimit operationId: CreateDisabilityPlanLimit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisabilityPlanLimit' text/json: schema: $ref: '#/components/schemas/DisabilityPlanLimit' application/*+json: schema: $ref: '#/components/schemas/DisabilityPlanLimit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityPlanLimitVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityPlanLimitVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityPlanLimitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Disability Limits summary: List DisabilityPlanLimit description: Lists all DisabilityPlanLimit for the given planID operationId: ListDisabilityPlanLimit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityPlanLimitListVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityPlanLimitListVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityPlanLimitListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/disability-limits/{disabilityPlanLimitKey}': get: tags: - Plan Disability Limits summary: Get DisabilityPlanLimit description: Gets DisabilityPlanLimit operationId: GetDisabilityPlanLimit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: disabilityPlanLimitKey in: path description: DisabilityPlanLimit Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityPlanLimitVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityPlanLimitVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityPlanLimitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Disability Limits summary: Update DisabilityPlanLimit description: Updates a specific DisabilityPlanLimit. operationId: UpdateDisabilityPlanLimit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: disabilityPlanLimitKey in: path description: DisabilityPlanLimit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DisabilityPlanLimit' text/json: schema: $ref: '#/components/schemas/DisabilityPlanLimit' application/*+json: schema: $ref: '#/components/schemas/DisabilityPlanLimit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisabilityPlanLimitVBAResponse' application/json: schema: $ref: '#/components/schemas/DisabilityPlanLimitVBAResponse' text/json: schema: $ref: '#/components/schemas/DisabilityPlanLimitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Disability Limits summary: Delete DisabilityPlanLimit description: Deletes an DisabilityPlanLimit operationId: DeleteDisabilityPlanLimit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: disabilityPlanLimitKey in: path description: DisabilityPlanLimit Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/disability-limits-batch': put: tags: - Plan Disability Limits summary: Create or Update Batch DisabilityPlanLimit description: 'Create or Update multiple DisabilityPlanLimit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDisabilityPlanLimit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DisabilityPlanLimit' text/json: schema: type: array items: $ref: '#/components/schemas/DisabilityPlanLimit' application/*+json: schema: type: array items: $ref: '#/components/schemas/DisabilityPlanLimit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disasters: post: tags: - Disasters summary: Create Disaster description: Creates a new Disaster operationId: CreateDisaster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Disaster' text/json: schema: $ref: '#/components/schemas/Disaster' application/*+json: schema: $ref: '#/components/schemas/Disaster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisasterVBAResponse' application/json: schema: $ref: '#/components/schemas/DisasterVBAResponse' text/json: schema: $ref: '#/components/schemas/DisasterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Disasters summary: List Disaster description: Lists all Disaster operationId: ListDisaster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisasterListVBAResponse' application/json: schema: $ref: '#/components/schemas/DisasterListVBAResponse' text/json: schema: $ref: '#/components/schemas/DisasterListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/disasters/{Disaster_Key}': get: tags: - Disasters summary: Get Disaster description: Gets Disaster operationId: GetDisaster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Disaster_Key in: path description: Disaster Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisasterVBAResponse' application/json: schema: $ref: '#/components/schemas/DisasterVBAResponse' text/json: schema: $ref: '#/components/schemas/DisasterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Disasters summary: Update Disaster description: Updates a specific Disaster. operationId: UpdateDisaster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Disaster_Key in: path description: Disaster Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Disaster' text/json: schema: $ref: '#/components/schemas/Disaster' application/*+json: schema: $ref: '#/components/schemas/Disaster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisasterVBAResponse' application/json: schema: $ref: '#/components/schemas/DisasterVBAResponse' text/json: schema: $ref: '#/components/schemas/DisasterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Disasters summary: Delete Disaster description: Deletes an Disaster operationId: DeleteDisaster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Disaster_Key in: path description: Disaster Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disasters-batch: put: tags: - Disasters summary: Create or Update Batch Disaster description: 'Create or Update multiple Disaster at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDisaster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Disaster' text/json: schema: type: array items: $ref: '#/components/schemas/Disaster' application/*+json: schema: type: array items: $ref: '#/components/schemas/Disaster' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disaster-locations: post: tags: - Disaster Locations summary: Create DisasterLocation description: Creates a new DisasterLocation operationId: CreateDisasterLocation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisasterLocation' text/json: schema: $ref: '#/components/schemas/DisasterLocation' application/*+json: schema: $ref: '#/components/schemas/DisasterLocation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisasterLocationVBAResponse' application/json: schema: $ref: '#/components/schemas/DisasterLocationVBAResponse' text/json: schema: $ref: '#/components/schemas/DisasterLocationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Disaster Locations summary: List DisasterLocation description: Lists all DisasterLocation operationId: ListDisasterLocation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisasterLocationListVBAResponse' application/json: schema: $ref: '#/components/schemas/DisasterLocationListVBAResponse' text/json: schema: $ref: '#/components/schemas/DisasterLocationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/disaster-locations/{DisasterLocation_Key}': get: tags: - Disaster Locations summary: Get DisasterLocation description: Gets DisasterLocation operationId: GetDisasterLocation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisasterLocation_Key in: path description: DisasterLocation Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisasterLocationVBAResponse' application/json: schema: $ref: '#/components/schemas/DisasterLocationVBAResponse' text/json: schema: $ref: '#/components/schemas/DisasterLocationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Disaster Locations summary: Update DisasterLocation description: Updates a specific DisasterLocation. operationId: UpdateDisasterLocation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisasterLocation_Key in: path description: DisasterLocation Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DisasterLocation' text/json: schema: $ref: '#/components/schemas/DisasterLocation' application/*+json: schema: $ref: '#/components/schemas/DisasterLocation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DisasterLocationVBAResponse' application/json: schema: $ref: '#/components/schemas/DisasterLocationVBAResponse' text/json: schema: $ref: '#/components/schemas/DisasterLocationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Disaster Locations summary: Delete DisasterLocation description: Deletes an DisasterLocation operationId: DeleteDisasterLocation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: DisasterLocation_Key in: path description: DisasterLocation Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /disaster-locations-batch: put: tags: - Disaster Locations summary: Create or Update Batch DisasterLocation description: 'Create or Update multiple DisasterLocation at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDisasterLocation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DisasterLocation' text/json: schema: type: array items: $ref: '#/components/schemas/DisasterLocation' application/*+json: schema: type: array items: $ref: '#/components/schemas/DisasterLocation' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /drg-clusters: post: tags: - DRG Cluster summary: Create DRGCluster description: Creates a new DRGCluster operationId: CreateDRGCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DRGCluster' text/json: schema: $ref: '#/components/schemas/DRGCluster' application/*+json: schema: $ref: '#/components/schemas/DRGCluster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - DRG Cluster summary: List DRGCluster description: List all DRGCluster operationId: ListDRGCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGClusterListVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGClusterListVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGClusterListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/drg-clusters/{drgCluster}': get: tags: - DRG Cluster summary: Get DRGCluster description: Gets DRGCluster operationId: GetDRGCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgCluster in: path description: DRG Cluster required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - DRG Cluster summary: Update DRGCluster description: Updates a specific DRGCluster. operationId: UpdateDRGCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgCluster in: path description: DRG Cluster required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DRGCluster' text/json: schema: $ref: '#/components/schemas/DRGCluster' application/*+json: schema: $ref: '#/components/schemas/DRGCluster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - DRG Cluster summary: Delete DRGCluster description: Deletes an DRGCluster operationId: DeleteDRGCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgCluster in: path description: DRG Cluster required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /drg-clusters-batch: put: tags: - DRG Cluster summary: Update Batch DRGCluster description: Updates multiple DRGClusters operationId: UpdateBatchDRGCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DRGCluster' text/json: schema: type: array items: $ref: '#/components/schemas/DRGCluster' application/*+json: schema: type: array items: $ref: '#/components/schemas/DRGCluster' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/drg-clusters/{drgCluster}/details': post: tags: - DRG Cluster Detail summary: Create DRGClusterDetail description: Creates a new DRGClusterDetail operationId: CreateDRGClusterDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgCluster in: path description: DRG Cluster required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DRGClusterDetail' text/json: schema: $ref: '#/components/schemas/DRGClusterDetail' application/*+json: schema: $ref: '#/components/schemas/DRGClusterDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGClusterDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGClusterDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGClusterDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - DRG Cluster Detail summary: List DRGClusterDetail description: Lists all DRGClusterDetail for the given drgCluster operationId: ListDRGClusterDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgCluster in: path description: DRG Cluster required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGClusterDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGClusterDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGClusterDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/drg-clusters/{drgCluster}/details/{drgClusterDetailKey}': get: tags: - DRG Cluster Detail summary: Get DRGClusterDetail description: Gets DRGClusterDetail operationId: GetDRGClusterDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgCluster in: path description: DRG Cluster required: true schema: type: string - name: drgClusterDetailKey in: path description: DRGClusterDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGClusterDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGClusterDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGClusterDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - DRG Cluster Detail summary: Update DRGClusterDetail description: Updates a specific DRGClusterDetail. operationId: UpdateDRGClusterDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgCluster in: path description: DRG Cluster required: true schema: type: string - name: drgClusterDetailKey in: path description: DRGClusterDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DRGClusterDetail' text/json: schema: $ref: '#/components/schemas/DRGClusterDetail' application/*+json: schema: $ref: '#/components/schemas/DRGClusterDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGClusterDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGClusterDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGClusterDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - DRG Cluster Detail summary: Delete DRGClusterDetail description: Deletes an DRGClusterDetail operationId: DeleteDRGClusterDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgCluster in: path description: DRG Cluster required: true schema: type: string - name: drgClusterDetailKey in: path description: DRGClusterDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/drg-clusters/{drgCluster}/details-batch': put: tags: - DRG Cluster Detail summary: Create or Update Batch DRGClusterDetail description: 'Create or Update multiple DRGClusterDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDRGClusterDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgCluster in: path description: DRG Cluster required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DRGClusterDetail' text/json: schema: type: array items: $ref: '#/components/schemas/DRGClusterDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/DRGClusterDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /drg-codes: post: tags: - DRG Codes summary: Create DRGCodes description: Creates a new DRGCodes operationId: CreateDRGCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DRGCodes' text/json: schema: $ref: '#/components/schemas/DRGCodes' application/*+json: schema: $ref: '#/components/schemas/DRGCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/drg-codes/{dRGCode}': get: tags: - DRG Codes summary: Get DRGCodes description: Gets DRGCodes operationId: GetDRGCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: dRGCode in: path description: DRG Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - DRG Codes summary: Update DRGCodes description: Updates a specific DRGCodes. operationId: UpdateDRGCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: dRGCode in: path description: DRG Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DRGCodes' text/json: schema: $ref: '#/components/schemas/DRGCodes' application/*+json: schema: $ref: '#/components/schemas/DRGCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - DRG Codes summary: Delete DRGCodes description: Deletes an DRGCodes operationId: DeleteDRGCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: dRGCode in: path description: DRG Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /drg-codes-batch: put: tags: - DRG Codes summary: Create or Update Batch DRGCodes description: 'Create or Update multiple DRGCodes at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDRGCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DRGCodes' text/json: schema: type: array items: $ref: '#/components/schemas/DRGCodes' application/*+json: schema: type: array items: $ref: '#/components/schemas/DRGCodes' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /drg-schedules: post: tags: - DRG Schedule summary: Create DRGSchedule description: Creates a new DRGSchedule operationId: CreateDRGSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DRGSchedule' text/json: schema: $ref: '#/components/schemas/DRGSchedule' application/*+json: schema: $ref: '#/components/schemas/DRGSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - DRG Schedule summary: List DRGSchedule description: List all DRGSchedule operationId: ListDRGSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGScheduleListVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGScheduleListVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGScheduleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/drg-schedules/{drgSchedule}': get: tags: - DRG Schedule summary: Get DRGSchedule description: Gets DRGSchedule operationId: GetDRGSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgSchedule in: path description: DRG Schedule required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - DRG Schedule summary: Update DRGSchedule description: Updates a specific DRGSchedule. operationId: UpdateDRGSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgSchedule in: path description: DRG Schedule required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DRGSchedule' text/json: schema: $ref: '#/components/schemas/DRGSchedule' application/*+json: schema: $ref: '#/components/schemas/DRGSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - DRG Schedule summary: Delete DRGSchedule description: Deletes an DRGSchedule operationId: DeleteDRGSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgSchedule in: path description: DRG Schedule required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /drg-schedules-batch: put: tags: - DRG Schedule summary: Create or Update Batch DRGSchedule description: 'Create or Update multiple DRGSchedule at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDRGSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DRGSchedule' text/json: schema: type: array items: $ref: '#/components/schemas/DRGSchedule' application/*+json: schema: type: array items: $ref: '#/components/schemas/DRGSchedule' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/drg-schedules/{drgSchedule}/drg-codes/{drgCode}/drg-weights': post: tags: - DRG Weight summary: Create DRGWeight description: Creates a new DRGWeight operationId: CreateDRGWeight parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgSchedule in: path description: DRG Schedule required: true schema: type: string - name: drgCode in: path description: DRG Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DRGWeight' text/json: schema: $ref: '#/components/schemas/DRGWeight' application/*+json: schema: $ref: '#/components/schemas/DRGWeight' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGWeightVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGWeightVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGWeightVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - DRG Weight summary: List DRGWeights description: List DRGWeights for a specific DRG Schedule and DRG Code operationId: ListDRGWeight parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgSchedule in: path description: DRG Schedule required: true schema: type: string - name: drgCode in: path description: DRG Code required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGWeightListVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGWeightListVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGWeightListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/drg-schedules/{drgSchedule}/drg-codes/{drgCode}/drg-weights/{effectiveDate}': get: tags: - DRG Weight summary: Get DRGWeight description: Gets DRGWeight operationId: GetDRGWeight parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgSchedule in: path description: DRG Schedule required: true schema: type: string - name: drgCode in: path description: DRG Code required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGWeightVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGWeightVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGWeightVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - DRG Weight summary: Update DRGWeight description: Updates a specific DRGWeight. operationId: UpdateDRGWeight parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgSchedule in: path description: DRG Schedule required: true schema: type: string - name: drgCode in: path description: DRG Code required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/DRGWeight' text/json: schema: $ref: '#/components/schemas/DRGWeight' application/*+json: schema: $ref: '#/components/schemas/DRGWeight' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DRGWeightVBAResponse' application/json: schema: $ref: '#/components/schemas/DRGWeightVBAResponse' text/json: schema: $ref: '#/components/schemas/DRGWeightVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - DRG Weight summary: Delete DRGWeight description: Deletes an DRGWeight operationId: DeleteDRGWeight parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgSchedule in: path description: DRG Schedule required: true schema: type: string - name: drgCode in: path description: DRG Code required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/drg-schedules/{drgSchedule}/drg-codes/{drgCode}/drg-weights-batch': put: tags: - DRG Weight summary: Create or Update Batch DRGWeight description: 'Create or Update multiple DRGWeight at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDRGWeight parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drgSchedule in: path description: DRG Schedule required: true schema: type: string - name: drgCode in: path description: DRG Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DRGWeight' text/json: schema: type: array items: $ref: '#/components/schemas/DRGWeight' application/*+json: schema: type: array items: $ref: '#/components/schemas/DRGWeight' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /drug-codes: post: tags: - Drug Codes summary: Create DrugCode description: Creates a new DrugCode operationId: CreateDrugCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DrugCode' text/json: schema: $ref: '#/components/schemas/DrugCode' application/*+json: schema: $ref: '#/components/schemas/DrugCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DrugCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/DrugCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/DrugCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Drug Codes summary: List DrugCode description: Lists all DrugCode operationId: ListDrugCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DrugCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/DrugCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/DrugCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/drug-codes/{drugCodeKey}': get: tags: - Drug Codes summary: Get DrugCode description: Gets DrugCode operationId: GetDrugCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drugCodeKey in: path description: DrugCode Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DrugCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/DrugCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/DrugCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Drug Codes summary: Update DrugCode description: Updates a specific DrugCode. operationId: UpdateDrugCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drugCodeKey in: path description: DrugCode Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DrugCode' text/json: schema: $ref: '#/components/schemas/DrugCode' application/*+json: schema: $ref: '#/components/schemas/DrugCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DrugCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/DrugCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/DrugCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Drug Codes summary: Delete DrugCode description: Deletes an DrugCode operationId: DeleteDrugCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drugCodeKey in: path description: DrugCode Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /drug-codes-batch: put: tags: - Drug Codes summary: Create or Update Batch DrugCode description: 'Create or Update multiple DrugCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDrugCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DrugCode' text/json: schema: type: array items: $ref: '#/components/schemas/DrugCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/DrugCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /drug-code-units: post: tags: - Drug Code Units summary: Create DrugCodeUnit description: Creates a new DrugCodeUnit operationId: CreateDrugCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DrugCodeUnit' text/json: schema: $ref: '#/components/schemas/DrugCodeUnit' application/*+json: schema: $ref: '#/components/schemas/DrugCodeUnit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DrugCodeUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/DrugCodeUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/DrugCodeUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Drug Code Units summary: List DrugCodeUnit description: Lists all DrugCodeUnit operationId: ListDrugCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DrugCodeUnitListVBAResponse' application/json: schema: $ref: '#/components/schemas/DrugCodeUnitListVBAResponse' text/json: schema: $ref: '#/components/schemas/DrugCodeUnitListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/drug-code-units/{drugCodeUnit}': get: tags: - Drug Code Units summary: Get DrugCodeUnit description: Gets DrugCodeUnit operationId: GetDrugCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drugCodeUnit in: path description: DrugCode Unit required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DrugCodeUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/DrugCodeUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/DrugCodeUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Drug Code Units summary: Update DrugCodeUnit description: Updates a specific DrugCodeUnit. operationId: UpdateDrugCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drugCodeUnit in: path description: DrugCode Unit required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DrugCodeUnit' text/json: schema: $ref: '#/components/schemas/DrugCodeUnit' application/*+json: schema: $ref: '#/components/schemas/DrugCodeUnit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DrugCodeUnitVBAResponse' application/json: schema: $ref: '#/components/schemas/DrugCodeUnitVBAResponse' text/json: schema: $ref: '#/components/schemas/DrugCodeUnitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Drug Code Units summary: Delete DrugCodeUnit description: Deletes an DrugCodeUnit operationId: DeleteDrugCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: drugCodeUnit in: path description: DrugCode Unit required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /drug-code-units-batch: put: tags: - Drug Code Units summary: Create or Update Batch DrugCodeUnit description: 'Create or Update multiple DrugCodeUnit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDrugCodeUnit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DrugCodeUnit' text/json: schema: type: array items: $ref: '#/components/schemas/DrugCodeUnit' application/*+json: schema: type: array items: $ref: '#/components/schemas/DrugCodeUnit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /duplicate-columns: post: tags: - Duplicate Columns summary: Create DuplicateColumn description: Creates a new DuplicateColumn operationId: CreateDuplicateColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DuplicateColumn' text/json: schema: $ref: '#/components/schemas/DuplicateColumn' application/*+json: schema: $ref: '#/components/schemas/DuplicateColumn' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateColumnVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateColumnVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateColumnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Duplicate Columns summary: List DuplicateColumn description: Lists all DuplicateColumn operationId: ListDuplicateColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateColumnListVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateColumnListVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateColumnListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/duplicate-columns/{duplicateColumnKey}': get: tags: - Duplicate Columns summary: Get DuplicateColumn description: Gets DuplicateColumn operationId: GetDuplicateColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateColumnKey in: path description: DuplicateColumn Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateColumnVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateColumnVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateColumnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Duplicate Columns summary: Update DuplicateColumn description: Updates a specific DuplicateColumn. operationId: UpdateDuplicateColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateColumnKey in: path description: DuplicateColumn Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DuplicateColumn' text/json: schema: $ref: '#/components/schemas/DuplicateColumn' application/*+json: schema: $ref: '#/components/schemas/DuplicateColumn' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateColumnVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateColumnVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateColumnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Duplicate Columns summary: Delete DuplicateColumn description: Deletes an DuplicateColumn operationId: DeleteDuplicateColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateColumnKey in: path description: DuplicateColumn Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /duplicate-columns-batch: put: tags: - Duplicate Columns summary: Create or Update Batch DuplicateColumn description: 'Create or Update multiple DuplicateColumn at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDuplicateColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DuplicateColumn' text/json: schema: type: array items: $ref: '#/components/schemas/DuplicateColumn' application/*+json: schema: type: array items: $ref: '#/components/schemas/DuplicateColumn' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /duplicate-masters: post: tags: - Duplicate Masters summary: Create DuplicateMaster description: Creates a new DuplicateMaster operationId: CreateDuplicateMaster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DuplicateMaster' text/json: schema: $ref: '#/components/schemas/DuplicateMaster' application/*+json: schema: $ref: '#/components/schemas/DuplicateMaster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateMasterVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateMasterVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateMasterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Duplicate Masters summary: List DuplicateMaster description: Lists all DuplicateMaster operationId: ListDuplicateMaster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateMasterListVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateMasterListVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateMasterListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/duplicate-masters/{duplicateMasterKey}': get: tags: - Duplicate Masters summary: Get DuplicateMaster description: Gets DuplicateMaster operationId: GetDuplicateMaster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateMasterKey in: path description: DuplicateMaster Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateMasterVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateMasterVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateMasterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Duplicate Masters summary: Update DuplicateMaster description: Updates a specific DuplicateMaster. operationId: UpdateDuplicateMaster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateMasterKey in: path description: DuplicateMaster Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DuplicateMaster' text/json: schema: $ref: '#/components/schemas/DuplicateMaster' application/*+json: schema: $ref: '#/components/schemas/DuplicateMaster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateMasterVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateMasterVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateMasterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Duplicate Masters summary: Delete DuplicateMaster description: Deletes an DuplicateMaster operationId: DeleteDuplicateMaster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateMasterKey in: path description: DuplicateMaster Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /duplicate-masters-batch: put: tags: - Duplicate Masters summary: Create or Update Batch DuplicateMaster description: 'Create or Update multiple DuplicateMaster at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDuplicateMaster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DuplicateMaster' text/json: schema: type: array items: $ref: '#/components/schemas/DuplicateMaster' application/*+json: schema: type: array items: $ref: '#/components/schemas/DuplicateMaster' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/duplicate-masters/{duplicateMasterKey}/sets': post: tags: - Duplicate Master Sets summary: Create DuplicateMasterSet description: Creates a new DuplicateMasterSet operationId: CreateDuplicateMasterSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateMasterKey in: path description: DuplicateMaster Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DuplicateMasterSet' text/json: schema: $ref: '#/components/schemas/DuplicateMasterSet' application/*+json: schema: $ref: '#/components/schemas/DuplicateMasterSet' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateMasterSetVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateMasterSetVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateMasterSetVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Duplicate Master Sets summary: List DuplicateMasterSet description: Lists all DuplicateMasterSet for the given duplicateMasterKey operationId: ListDuplicateMasterSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateMasterKey in: path description: DuplicateMaster Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateMasterSetListVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateMasterSetListVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateMasterSetListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/duplicate-masters/{duplicateMasterKey}/sets/{duplicateSetKey}': get: tags: - Duplicate Master Sets summary: Get DuplicateMasterSet description: Gets DuplicateMasterSet operationId: GetDuplicateMasterSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateMasterKey in: path description: DuplicateMaster Key required: true schema: type: integer format: int32 - name: duplicateSetKey in: path description: DuplicateSet Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateMasterSetVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateMasterSetVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateMasterSetVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Duplicate Master Sets summary: Update DuplicateMasterSet description: Updates a specific DuplicateMasterSet. operationId: UpdateDuplicateMasterSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateMasterKey in: path description: DuplicateMaster Key required: true schema: type: integer format: int32 - name: duplicateSetKey in: path description: DuplicateSet Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DuplicateMasterSet' text/json: schema: $ref: '#/components/schemas/DuplicateMasterSet' application/*+json: schema: $ref: '#/components/schemas/DuplicateMasterSet' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateMasterSetVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateMasterSetVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateMasterSetVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Duplicate Master Sets summary: Delete DuplicateMasterSet description: Deletes an DuplicateMasterSet operationId: DeleteDuplicateMasterSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateMasterKey in: path description: DuplicateMaster Key required: true schema: type: integer format: int32 - name: duplicateSetKey in: path description: DuplicateSet Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/duplicate-masters/{duplicateMasterKey}/sets-batch': put: tags: - Duplicate Master Sets summary: Create or Update Batch DuplicateMasterSet description: 'Create or Update multiple DuplicateMasterSet at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDuplicateMasterSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateMasterKey in: path description: DuplicateMaster Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DuplicateMasterSet' text/json: schema: type: array items: $ref: '#/components/schemas/DuplicateMasterSet' application/*+json: schema: type: array items: $ref: '#/components/schemas/DuplicateMasterSet' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /duplicate-sets: post: tags: - Duplicate Sets summary: Create DuplicateSet description: Creates a new DuplicateSet operationId: CreateDuplicateSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DuplicateSet' text/json: schema: $ref: '#/components/schemas/DuplicateSet' application/*+json: schema: $ref: '#/components/schemas/DuplicateSet' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateSetVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateSetVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateSetVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Duplicate Sets summary: List DuplicateSet description: Lists all DuplicateSet operationId: ListDuplicateSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateSetListVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateSetListVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateSetListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/duplicate-sets/{duplicateSetKey}': get: tags: - Duplicate Sets summary: Get DuplicateSet description: Gets DuplicateSet operationId: GetDuplicateSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateSetKey in: path description: DuplicateSet Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateSetVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateSetVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateSetVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Duplicate Sets summary: Update DuplicateSet description: Updates a specific DuplicateSet. operationId: UpdateDuplicateSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateSetKey in: path description: DuplicateSet Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DuplicateSet' text/json: schema: $ref: '#/components/schemas/DuplicateSet' application/*+json: schema: $ref: '#/components/schemas/DuplicateSet' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateSetVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateSetVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateSetVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Duplicate Sets summary: Delete DuplicateSet description: Deletes an DuplicateSet operationId: DeleteDuplicateSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateSetKey in: path description: DuplicateSet Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /duplicate-sets-batch: put: tags: - Duplicate Sets summary: Create or Update Batch DuplicateSet description: 'Create or Update multiple DuplicateSet at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDuplicateSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DuplicateSet' text/json: schema: type: array items: $ref: '#/components/schemas/DuplicateSet' application/*+json: schema: type: array items: $ref: '#/components/schemas/DuplicateSet' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/duplicate-sets/{duplicateSetKey}/columns': post: tags: - Duplicate Set Columns summary: Create DuplicateSetColumn description: Creates a new DuplicateSetColumn operationId: CreateDuplicateSetColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateSetKey in: path description: DuplicateSet Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DuplicateSetColumn' text/json: schema: $ref: '#/components/schemas/DuplicateSetColumn' application/*+json: schema: $ref: '#/components/schemas/DuplicateSetColumn' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateSetColumnVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateSetColumnVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateSetColumnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Duplicate Set Columns summary: List DuplicateSetColumn description: Lists all DuplicateSetColumn for the given duplicateSetKey operationId: ListDuplicateSetColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateSetKey in: path description: DuplicateSet Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateSetColumnListVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateSetColumnListVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateSetColumnListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/duplicate-sets/{duplicateSetKey}/columns/{duplicateColumnKey}': get: tags: - Duplicate Set Columns summary: Get DuplicateSetColumn description: Gets DuplicateSetColumn operationId: GetDuplicateSetColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateSetKey in: path description: DuplicateSet Key required: true schema: type: integer format: int32 - name: duplicateColumnKey in: path description: DuplicateColumn Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateSetColumnVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateSetColumnVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateSetColumnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Duplicate Set Columns summary: Update DuplicateSetColumn description: Updates a specific DuplicateSetColumn. operationId: UpdateDuplicateSetColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateSetKey in: path description: DuplicateSet Key required: true schema: type: integer format: int32 - name: duplicateColumnKey in: path description: DuplicateColumn Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DuplicateSetColumn' text/json: schema: $ref: '#/components/schemas/DuplicateSetColumn' application/*+json: schema: $ref: '#/components/schemas/DuplicateSetColumn' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DuplicateSetColumnVBAResponse' application/json: schema: $ref: '#/components/schemas/DuplicateSetColumnVBAResponse' text/json: schema: $ref: '#/components/schemas/DuplicateSetColumnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Duplicate Set Columns summary: Delete DuplicateSetColumn description: Deletes an DuplicateSetColumn operationId: DeleteDuplicateSetColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateSetKey in: path description: DuplicateSet Key required: true schema: type: integer format: int32 - name: duplicateColumnKey in: path description: DuplicateColumn Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/duplicate-sets/{duplicateSetKey}/columns-batch': put: tags: - Duplicate Set Columns summary: Create or Update Batch DuplicateSetColumn description: 'Create or Update multiple DuplicateSetColumn at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchDuplicateSetColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: duplicateSetKey in: path description: DuplicateSet Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DuplicateSetColumn' text/json: schema: type: array items: $ref: '#/components/schemas/DuplicateSetColumn' application/*+json: schema: type: array items: $ref: '#/components/schemas/DuplicateSetColumn' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /edi-code-mapping: post: tags: - EDI Code Mappings summary: Create EDICodeMap description: Creates a new EDICodeMap operationId: CreateEDICodeMap parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EDICodeMap' text/json: schema: $ref: '#/components/schemas/EDICodeMap' application/*+json: schema: $ref: '#/components/schemas/EDICodeMap' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EDICodeMapVBAResponse' application/json: schema: $ref: '#/components/schemas/EDICodeMapVBAResponse' text/json: schema: $ref: '#/components/schemas/EDICodeMapVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - EDI Code Mappings summary: List EDICodeMap description: Lists all EDICodeMap operationId: ListEDICodeMap parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EDICodeMapListVBAResponse' application/json: schema: $ref: '#/components/schemas/EDICodeMapListVBAResponse' text/json: schema: $ref: '#/components/schemas/EDICodeMapListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/edi-code-mapping/{eDICodeMapKey}': get: tags: - EDI Code Mappings summary: Get EDICodeMap description: Gets EDICodeMap operationId: GetEDICodeMap parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eDICodeMapKey in: path description: EDICodeMap Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EDICodeMapVBAResponse' application/json: schema: $ref: '#/components/schemas/EDICodeMapVBAResponse' text/json: schema: $ref: '#/components/schemas/EDICodeMapVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - EDI Code Mappings summary: Update EDICodeMap description: Updates a specific EDICodeMap. operationId: UpdateEDICodeMap parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eDICodeMapKey in: path description: EDICodeMap Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EDICodeMap' text/json: schema: $ref: '#/components/schemas/EDICodeMap' application/*+json: schema: $ref: '#/components/schemas/EDICodeMap' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EDICodeMapVBAResponse' application/json: schema: $ref: '#/components/schemas/EDICodeMapVBAResponse' text/json: schema: $ref: '#/components/schemas/EDICodeMapVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - EDI Code Mappings summary: Delete EDICodeMap description: Deletes an EDICodeMap operationId: DeleteEDICodeMap parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eDICodeMapKey in: path description: EDICodeMap Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /edi-code-mapping-batch: put: tags: - EDI Code Mappings summary: Create or Update Batch EDICodeMap description: 'Create or Update multiple EDICodeMap at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchEDICodeMap parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/EDICodeMap' text/json: schema: type: array items: $ref: '#/components/schemas/EDICodeMap' application/*+json: schema: type: array items: $ref: '#/components/schemas/EDICodeMap' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /edi-custom-fields: post: tags: - EDICustomFields summary: Create EDICustomField description: Creates a new EDICustomField operationId: CreateEDICustomField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EDICustomField' text/json: schema: $ref: '#/components/schemas/EDICustomField' application/*+json: schema: $ref: '#/components/schemas/EDICustomField' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EDICustomFieldVBAResponse' application/json: schema: $ref: '#/components/schemas/EDICustomFieldVBAResponse' text/json: schema: $ref: '#/components/schemas/EDICustomFieldVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - EDICustomFields summary: List EDICustomField description: Lists all EDICustomField operationId: ListEDICustomField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EDICustomFieldListVBAResponse' application/json: schema: $ref: '#/components/schemas/EDICustomFieldListVBAResponse' text/json: schema: $ref: '#/components/schemas/EDICustomFieldListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/edi-custom-fields/{EDICustomField_Key}': get: tags: - EDICustomFields summary: Get EDICustomField description: Gets EDICustomField operationId: GetEDICustomField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: EDICustomField_Key in: path description: EDICustomField Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EDICustomFieldVBAResponse' application/json: schema: $ref: '#/components/schemas/EDICustomFieldVBAResponse' text/json: schema: $ref: '#/components/schemas/EDICustomFieldVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - EDICustomFields summary: Update EDICustomField description: Updates a specific EDICustomField. operationId: UpdateEDICustomField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: EDICustomField_Key in: path description: EDICustomField Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EDICustomField' text/json: schema: $ref: '#/components/schemas/EDICustomField' application/*+json: schema: $ref: '#/components/schemas/EDICustomField' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EDICustomFieldVBAResponse' application/json: schema: $ref: '#/components/schemas/EDICustomFieldVBAResponse' text/json: schema: $ref: '#/components/schemas/EDICustomFieldVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - EDICustomFields summary: Delete EDICustomField description: Deletes an EDICustomField operationId: DeleteEDICustomField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: EDICustomField_Key in: path description: EDICustomField Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /edi-custom-fields-batch: put: tags: - EDICustomFields summary: Create or Update Batch EDICustomField description: 'Create or Update multiple EDICustomField at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchEDICustomField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/EDICustomField' text/json: schema: type: array items: $ref: '#/components/schemas/EDICustomField' application/*+json: schema: type: array items: $ref: '#/components/schemas/EDICustomField' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /edi-custom-field-value-claims: post: tags: - EDICustomFieldValueClaims summary: Create EDICustomFieldValueClaim description: Creates a new EDICustomFieldValueClaim operationId: CreateEDICustomFieldValueClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaim' text/json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaim' application/*+json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaim' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EDICustomFieldValueClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - EDICustomFieldValueClaims summary: List EDICustomFieldValueClaim description: Lists all EDICustomFieldValueClaim operationId: ListEDICustomFieldValueClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EDICustomFieldValueClaimListVBAResponse' application/json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaimListVBAResponse' text/json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaimListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/edi-custom-field-value-claims/{EDICustomFieldValueClaim_Key}': get: tags: - EDICustomFieldValueClaims summary: Get EDICustomFieldValueClaim description: Gets EDICustomFieldValueClaim operationId: GetEDICustomFieldValueClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: EDICustomFieldValueClaim_Key in: path description: EDICustomFieldValueClaim Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EDICustomFieldValueClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - EDICustomFieldValueClaims summary: Update EDICustomFieldValueClaim description: Updates a specific EDICustomFieldValueClaim. operationId: UpdateEDICustomFieldValueClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: EDICustomFieldValueClaim_Key in: path description: EDICustomFieldValueClaim Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaim' text/json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaim' application/*+json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaim' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EDICustomFieldValueClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/EDICustomFieldValueClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - EDICustomFieldValueClaims summary: Delete EDICustomFieldValueClaim description: Deletes an EDICustomFieldValueClaim operationId: DeleteEDICustomFieldValueClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: EDICustomFieldValueClaim_Key in: path description: EDICustomFieldValueClaim Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /edi-custom-field-value-claims-batch: put: tags: - EDICustomFieldValueClaims summary: Create or Update Batch EDICustomFieldValueClaim description: 'Create or Update multiple EDICustomFieldValueClaim at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchEDICustomFieldValueClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/EDICustomFieldValueClaim' text/json: schema: type: array items: $ref: '#/components/schemas/EDICustomFieldValueClaim' application/*+json: schema: type: array items: $ref: '#/components/schemas/EDICustomFieldValueClaim' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /eligibility-statuses: post: tags: - Eligibility Status summary: Create EligibilityStatus description: Creates a new EligibilityStatus operationId: CreateEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EligibilityStatus' text/json: schema: $ref: '#/components/schemas/EligibilityStatus' application/*+json: schema: $ref: '#/components/schemas/EligibilityStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EligibilityStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/EligibilityStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/EligibilityStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Eligibility Status summary: List EligibilityStatus description: Lists all EligibilityStatus for the given eligibilityStatus operationId: ListEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EligibilityStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/EligibilityStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/EligibilityStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/eligibility-statuses/{eligibilityStatus}': get: tags: - Eligibility Status summary: Get EligibilityStatus description: Gets EligibilityStatus operationId: GetEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eligibilityStatus in: path description: Eligibility Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EligibilityStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/EligibilityStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/EligibilityStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Eligibility Status summary: Update EligibilityStatus description: Updates a specific EligibilityStatus. operationId: UpdateEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eligibilityStatus in: path description: Eligibility Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EligibilityStatus' text/json: schema: $ref: '#/components/schemas/EligibilityStatus' application/*+json: schema: $ref: '#/components/schemas/EligibilityStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EligibilityStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/EligibilityStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/EligibilityStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Eligibility Status summary: Delete EligibilityStatus description: Deletes an EligibilityStatus operationId: DeleteEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eligibilityStatus in: path description: Eligibility Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /eligibility-statuses-batch: put: tags: - Eligibility Status summary: Create or Update Batch EligibilityStatus description: 'Create or Update multiple EligibilityStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/EligibilityStatus' text/json: schema: type: array items: $ref: '#/components/schemas/EligibilityStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/EligibilityStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/change-id': post: tags: - Subscribers - Adv. Enrollment summary: Change Subscriber ID description: Changes a Subscriber ID globally operationId: ChangesubscriberID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSubscriberIDRequest' text/json: schema: $ref: '#/components/schemas/ChangeSubscriberIDRequest' application/*+json: schema: $ref: '#/components/schemas/ChangeSubscriberIDRequest' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/subscribers/{subscriberID}/members/{memberSeq}/disenroll': post: tags: - Subscribers - Adv. Enrollment summary: Member Disenroll description: Disenrolls a Member from an Enrollment. A VBAProcess object is returned representing the process state. See VBAProcess area for more information. operationId: MemberDisenroll parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnrollmentDisenroll' text/json: schema: $ref: '#/components/schemas/EnrollmentDisenroll' application/*+json: schema: $ref: '#/components/schemas/EnrollmentDisenroll' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/subscribers/{subscriberID}/as-of-date/{asOfDate}/disenroll-adjustments': get: tags: - Subscribers - Adv. Enrollment - Adv. Billing summary: List Billing Adjustments for Disenroll description: List of Billing Adjustments that would be created based on a Subscriber being disenrolled on the As of Date. operationId: ListDisenrollAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: asOfDate in: path description: As of Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceGenerateInvListResultListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceGenerateInvListResultListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceGenerateInvListResultListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /enrollment-waiting-period-by-hire-date: get: tags: - Subscribers - Adv. Enrollment summary: List Waiting Period Details description: 'List of Waiting Period configuration based on the passed in settings (group, division, plan, and/or hire date).' operationId: ListEnrollmentWaitingPeriodByHireDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: query description: Group ID schema: type: string - name: divisionID in: query description: Division ID schema: type: string - name: planID in: query description: Plan ID schema: type: string - name: hireDate in: query description: Hire Date schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodByHireDateListVBAResponse' application/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodByHireDateListVBAResponse' text/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodByHireDateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/subscribers/{subscriberID}/members/{memberSeq}/reenroll': post: tags: - Subscribers - Adv. Enrollment summary: Member Re-enroll description: Re-enrolls a Member to an Enrollment. A VBAProcess object is returned representing the process state. See VBAProcess area for more information. operationId: MemberReenroll parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnrollmentReenroll' text/json: schema: $ref: '#/components/schemas/EnrollmentReenroll' application/*+json: schema: $ref: '#/components/schemas/EnrollmentReenroll' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/subscribers/{subscriberID}/add-enrollment': post: tags: - Subscribers - Adv. Enrollment summary: Subscriber Add Enrollment description: Adds enrollments to an existing subscriber. Can add enrollment for the subscriber or subscriber + all members. operationId: SubscriberAddEnrollment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AddEnrollmentRequest' text/json: schema: $ref: '#/components/schemas/AddEnrollmentRequest' application/*+json: schema: $ref: '#/components/schemas/AddEnrollmentRequest' required: true responses: '202': description: Accepted '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/subscribers/{subscriberID}/surrender-policy/{planID}/{benefitCode}/{policyNumber}/{cashValue}': post: tags: - Subscriber Plan Policies - Adv. Enrollment summary: Subscriber Policy Surrender description: Surrender an existing Policy under the Policy & Forfeiture area. operationId: SubscriberSurrenderPolicy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string - name: cashValue in: path description: Cash Value required: true schema: type: number format: double responses: '202': description: Accepted '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/subscribers/{subscriberID}/division-transfer/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/{currentEnrollEndDate}/{newEnrollStartDate}/{newEnrollDivisionID}': post: tags: - Adv. Enrollment summary: Subscriber Division Transfer description: Transfer a Subscriber Enrollment from one Division to another. operationId: SubscriberDivisionTransfer parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time - name: currentEnrollEndDate in: path description: Current Enrollment End Date required: true schema: type: string format: date-time - name: newEnrollStartDate in: path description: New Enrollment Start Date required: true schema: type: string format: date-time - name: newEnrollDivisionID in: path description: New Enrollment DivisionID required: true schema: type: string responses: '202': description: Accepted '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /disenroll-family-options: get: tags: - Subscribers summary: List Disenrollment Family Options description: List of all Disenrollment Family Options operationId: ListDisenrollmentFamilyOptions parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reenroll-family-options: get: tags: - Subscribers summary: List Reenrollment Family Options description: List of all Reenrollment Family Options operationId: ListReenrollmentFamilyOptions parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /cobra-duration-types: get: tags: - Subscribers summary: List Cobra Duration Types description: List of all Cobra Duration Types operationId: ListCobraDurationTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /cobra-disenroll-reason-types: get: tags: - Subscribers summary: List Cobra Disenroll Reason Types description: List of all Cobra Disenroll Reason Types operationId: ListCobraDisenrollReasonTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /waiting-period-types: get: tags: - Waiting Period Types summary: List Waiting Period Types description: List of all Waiting Period Types operationId: ListWaitingPeriodTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/recalculate-accumulators': post: tags: - Enrollment Accumulators - Adv. Enrollment summary: Recalculate Subscriber Accumulators description: Recalculate Accumulators for a given Subscriber ID operationId: SubscriberRecalcAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/subscribers/{subscriberID}/members/{memberSeq}/recalculate-teeth': post: tags: - Enrollment Accumulators - Adv. Enrollment summary: Recalculate Member Teeth description: Recalculate All Teeth for a given Subscriber and Member. Pass the requestingUserId if this request is being made on behalf of another User. operationId: RecalculateMemberTeeth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: requestingUserId in: query description: Requesting User schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /auto-assign-primary-care-physician: post: tags: - Members summary: Auto-Assign Primary Care Physician description: Automatically assigns a Primary care Physician to Members based on the Criteria found in the EnrollmentPCPAutoAssign entity passed in the body. operationId: AutoAssignPriaryCarePhysician parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestingUserId in: query description: Requesting User schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnrollmentPCPAutoAssign' text/json: schema: $ref: '#/components/schemas/EnrollmentPCPAutoAssign' application/*+json: schema: $ref: '#/components/schemas/EnrollmentPCPAutoAssign' required: true responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auto-assign-primary-care-physician-members: get: tags: - Members summary: List Members with Auto-Assign Primary Care Physician description: Get a list of Members that will be automatically assigned a Primary care Physician. operationId: ListAutoAssignPriaryCarePhysicianMembers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: runDate in: query description: Run Date schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EnrollmentPCPAutoAssign_MemberListVBAResponse' application/json: schema: $ref: '#/components/schemas/EnrollmentPCPAutoAssign_MemberListVBAResponse' text/json: schema: $ref: '#/components/schemas/EnrollmentPCPAutoAssign_MemberListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /auto-assign-primary-care-physician-providers: get: tags: - Members summary: List Providers that are eligible for PCP Auto-Assign description: Get a list of Providers that are eligible for PCP Auto-Assign for the given Networks and Provider Types. operationId: ListProvidersWithPCPAutoAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networks in: query description: Networks as a comma separated list of strings schema: type: string - name: practiceTypes in: query description: Practice Types as a comma separated list of strings schema: type: string - name: expirationDate in: query description: Expiration Date schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EnrollmentPCPAutoAssign_ProviderListVBAResponse' application/json: schema: $ref: '#/components/schemas/EnrollmentPCPAutoAssign_ProviderListVBAResponse' text/json: schema: $ref: '#/components/schemas/EnrollmentPCPAutoAssign_ProviderListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/plans/{planID}/benefits/{benefitCode}/policies/{policyNumber}/forfeiture': post: tags: - Subscriber Plan Policy Forfeitures summary: Subscriber Policy Forfeiture description: Forfeits a Policy for a given Subscriber ID operationId: SubscriberPolicyForfeiture parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnrollmentPolicyForfeiture' text/json: schema: $ref: '#/components/schemas/EnrollmentPolicyForfeiture' application/*+json: schema: $ref: '#/components/schemas/EnrollmentPolicyForfeiture' required: true responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /enrollment-waiting-periods: post: tags: - Enrollment Waiting Periods summary: Create EnrollmentWaitingPeriod description: Creates a new EnrollmentWaitingPeriod operationId: CreateEnrollmentWaitingPeriod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriod' text/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriod' application/*+json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodVBAResponse' application/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodVBAResponse' text/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Enrollment Waiting Periods summary: List EnrollmentWaitingPeriod description: Lists all EnrollmentWaitingPeriod operationId: ListEnrollmentWaitingPeriod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodListVBAResponse' application/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodListVBAResponse' text/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/enrollment-waiting-periods/{enrollmentWaitingPeriodKey}': get: tags: - Enrollment Waiting Periods summary: Get EnrollmentWaitingPeriod description: Gets EnrollmentWaitingPeriod operationId: GetEnrollmentWaitingPeriod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: enrollmentWaitingPeriodKey in: path description: EnrollmentWaitingPeriod Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodVBAResponse' application/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodVBAResponse' text/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Enrollment Waiting Periods summary: Update EnrollmentWaitingPeriod description: Updates a specific EnrollmentWaitingPeriod. operationId: UpdateEnrollmentWaitingPeriod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: enrollmentWaitingPeriodKey in: path description: EnrollmentWaitingPeriod Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriod' text/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriod' application/*+json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodVBAResponse' application/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodVBAResponse' text/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Enrollment Waiting Periods summary: Delete EnrollmentWaitingPeriod description: Deletes an EnrollmentWaitingPeriod operationId: DeleteEnrollmentWaitingPeriod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: enrollmentWaitingPeriodKey in: path description: EnrollmentWaitingPeriod Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /enrollment-waiting-periods-batch: put: tags: - Enrollment Waiting Periods summary: Create or Update Batch EnrollmentWaitingPeriod description: 'Create or Update multiple EnrollmentWaitingPeriod at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchEnrollmentWaitingPeriod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/EnrollmentWaitingPeriod' text/json: schema: type: array items: $ref: '#/components/schemas/EnrollmentWaitingPeriod' application/*+json: schema: type: array items: $ref: '#/components/schemas/EnrollmentWaitingPeriod' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /enrollment-waiting-period-subscribers: post: tags: - Enrollment Waiting Period Subscribers summary: Create EnrollmentWaitingPeriodSubscriber description: Creates a new EnrollmentWaitingPeriodSubscriber operationId: CreateEnrollmentWaitingPeriodSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriber' text/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriber' application/*+json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriber' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Enrollment Waiting Period Subscribers summary: List EnrollmentWaitingPeriodSubscriber description: Lists all EnrollmentWaitingPeriodSubscriber operationId: ListEnrollmentWaitingPeriodSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: query description: Subscriber_ID schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriberListVBAResponse' application/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriberListVBAResponse' text/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriberListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/enrollment-waiting-period-subscribers/{enrollmentWaitingPeriodSubscriberKey}': get: tags: - Enrollment Waiting Period Subscribers summary: Get EnrollmentWaitingPeriodSubscriber description: Gets EnrollmentWaitingPeriodSubscriber operationId: GetEnrollmentWaitingPeriodSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: enrollmentWaitingPeriodSubscriberKey in: path description: EnrollmentWaitingPeriodSubscriber Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Enrollment Waiting Period Subscribers summary: Update EnrollmentWaitingPeriodSubscriber description: Updates a specific EnrollmentWaitingPeriodSubscriber. operationId: UpdateEnrollmentWaitingPeriodSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: enrollmentWaitingPeriodSubscriberKey in: path description: EnrollmentWaitingPeriodSubscriber Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriber' text/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriber' application/*+json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriber' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Enrollment Waiting Period Subscribers summary: Delete EnrollmentWaitingPeriodSubscriber description: Deletes an EnrollmentWaitingPeriodSubscriber operationId: DeleteEnrollmentWaitingPeriodSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: enrollmentWaitingPeriodSubscriberKey in: path description: EnrollmentWaitingPeriodSubscriber Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /enrollment-waiting-period-subscribers-batch: put: tags: - Enrollment Waiting Period Subscribers summary: Create or Update Batch EnrollmentWaitingPeriodSubscriber description: 'Create or Update multiple EnrollmentWaitingPeriodSubscriber at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchEnrollmentWaitingPeriodSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriber' text/json: schema: type: array items: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriber' application/*+json: schema: type: array items: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriber' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /error-categories: post: tags: - Error Category summary: Create ErrorCategory description: Creates a new ErrorCategory operationId: CreateErrorCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ErrorCategory' text/json: schema: $ref: '#/components/schemas/ErrorCategory' application/*+json: schema: $ref: '#/components/schemas/ErrorCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Error Category summary: List ErrorCategory description: Lists all ErrorCategory operationId: ListErrorCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/error-categories/{errorCategory}': get: tags: - Error Category summary: Get ErrorCategory description: Gets ErrorCategory operationId: GetErrorCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorCategory in: path description: Error Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Error Category summary: Update ErrorCategory description: Updates a specific ErrorCategory. operationId: UpdateErrorCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorCategory in: path description: Error Category required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ErrorCategory' text/json: schema: $ref: '#/components/schemas/ErrorCategory' application/*+json: schema: $ref: '#/components/schemas/ErrorCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Error Category summary: Delete ErrorCategory description: Deletes an ErrorCategory operationId: DeleteErrorCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorCategory in: path description: Error Category required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /error-categories-batch: put: tags: - Error Category summary: Create or Update Batch ErrorCategory description: 'Create or Update multiple ErrorCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchErrorCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ErrorCategory' text/json: schema: type: array items: $ref: '#/components/schemas/ErrorCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/ErrorCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /error-category-types: post: tags: - Error Category Types summary: Create ErrorCategoryType description: Creates a new ErrorCategoryType operationId: CreateErrorCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ErrorCategoryType' text/json: schema: $ref: '#/components/schemas/ErrorCategoryType' application/*+json: schema: $ref: '#/components/schemas/ErrorCategoryType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorCategoryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorCategoryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorCategoryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Error Category Types summary: List ErrorCategoryType description: Lists all ErrorCategoryType operationId: ListErrorCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorCategoryTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorCategoryTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorCategoryTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/error-category-types/{errorCategory}/{errorType}/{errorCode}': get: tags: - Error Category Types summary: Get ErrorCategoryType description: Gets ErrorCategoryType operationId: GetErrorCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorCategory in: path description: Error Category required: true schema: type: string - name: errorType in: path description: Error Type required: true schema: type: string - name: errorCode in: path description: Error Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorCategoryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorCategoryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorCategoryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Error Category Types summary: Update ErrorCategoryType description: Updates a specific ErrorCategoryType. operationId: UpdateErrorCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorCategory in: path description: Error Category required: true schema: type: string - name: errorType in: path description: Error Type required: true schema: type: string - name: errorCode in: path description: Error Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ErrorCategoryType' text/json: schema: $ref: '#/components/schemas/ErrorCategoryType' application/*+json: schema: $ref: '#/components/schemas/ErrorCategoryType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorCategoryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorCategoryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorCategoryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Error Category Types summary: Delete ErrorCategoryType description: Deletes an ErrorCategoryType operationId: DeleteErrorCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorCategory in: path description: Error Category required: true schema: type: string - name: errorType in: path description: Error Type required: true schema: type: string - name: errorCode in: path description: Error Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /error-category-types-batch: put: tags: - Error Category Types summary: Create or Update Batch ErrorCategoryType description: 'Create or Update multiple ErrorCategoryType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchErrorCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ErrorCategoryType' text/json: schema: type: array items: $ref: '#/components/schemas/ErrorCategoryType' application/*+json: schema: type: array items: $ref: '#/components/schemas/ErrorCategoryType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /error-severities: post: tags: - Error Severity summary: Create ErrorSeverity description: Creates a new ErrorSeverity operationId: CreateErrorSeverity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ErrorSeverity' text/json: schema: $ref: '#/components/schemas/ErrorSeverity' application/*+json: schema: $ref: '#/components/schemas/ErrorSeverity' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorSeverityVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorSeverityVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorSeverityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Error Severity summary: List ErrorSeverity description: Lists all ErrorSeverity operationId: ListErrorSeverity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorSeverityListVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorSeverityListVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorSeverityListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/error-severities/{errorSeverity}': get: tags: - Error Severity summary: Get ErrorSeverity description: Gets ErrorSeverity operationId: GetErrorSeverity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorSeverity in: path description: Error Severity required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorSeverityVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorSeverityVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorSeverityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Error Severity summary: Update ErrorSeverity description: Updates a specific ErrorSeverity. operationId: UpdateErrorSeverity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorSeverity in: path description: Error Severity required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ErrorSeverity' text/json: schema: $ref: '#/components/schemas/ErrorSeverity' application/*+json: schema: $ref: '#/components/schemas/ErrorSeverity' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorSeverityVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorSeverityVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorSeverityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Error Severity summary: Delete ErrorSeverity description: Deletes an ErrorSeverity operationId: DeleteErrorSeverity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorSeverity in: path description: Error Severity required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /error-severities-batch: put: tags: - Error Severity summary: Create or Update Batch ErrorSeverity description: 'Create or Update multiple ErrorSeverity at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchErrorSeverity parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ErrorSeverity' text/json: schema: type: array items: $ref: '#/components/schemas/ErrorSeverity' application/*+json: schema: type: array items: $ref: '#/components/schemas/ErrorSeverity' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /error-error-types: post: tags: - Error Type summary: Create ErrorType description: Creates a new ErrorType operationId: CreateErrorType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ErrorType' text/json: schema: $ref: '#/components/schemas/ErrorType' application/*+json: schema: $ref: '#/components/schemas/ErrorType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Error Type summary: List ErrorType description: Lists all ErrorType operationId: ListErrorType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/error-error-types/{errorType}': get: tags: - Error Type summary: Get ErrorType description: Gets ErrorType operationId: GetErrorType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorType in: path description: Error Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Error Type summary: Update ErrorType description: Updates a specific ErrorType. operationId: UpdateErrorType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorType in: path description: Error Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ErrorType' text/json: schema: $ref: '#/components/schemas/ErrorType' application/*+json: schema: $ref: '#/components/schemas/ErrorType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ErrorTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ErrorTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ErrorTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Error Type summary: Delete ErrorType description: Deletes an ErrorType operationId: DeleteErrorType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: errorType in: path description: Error Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /error-error-types-batch: put: tags: - Error Type summary: Create or Update Batch ErrorType description: 'Create or Update multiple ErrorType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchErrorType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ErrorType' text/json: schema: type: array items: $ref: '#/components/schemas/ErrorType' application/*+json: schema: type: array items: $ref: '#/components/schemas/ErrorType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /ethnicity-codes: post: tags: - Ethnicity Codes summary: Create EthnicityCode description: Creates a new EthnicityCode operationId: CreateEthnicityCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EthnicityCode' text/json: schema: $ref: '#/components/schemas/EthnicityCode' application/*+json: schema: $ref: '#/components/schemas/EthnicityCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EthnicityCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/EthnicityCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/EthnicityCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Ethnicity Codes summary: List EthnicityCode description: Lists all EthnicityCode operationId: ListEthnicityCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EthnicityCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/EthnicityCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/EthnicityCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/ethnicity-codes/{ethnicityCode}': get: tags: - Ethnicity Codes summary: Get EthnicityCode description: Gets EthnicityCode operationId: GetEthnicityCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ethnicityCode in: path description: Ethnicity Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EthnicityCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/EthnicityCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/EthnicityCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Ethnicity Codes summary: Update EthnicityCode description: Updates a specific EthnicityCode. operationId: UpdateEthnicityCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ethnicityCode in: path description: Ethnicity Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EthnicityCode' text/json: schema: $ref: '#/components/schemas/EthnicityCode' application/*+json: schema: $ref: '#/components/schemas/EthnicityCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EthnicityCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/EthnicityCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/EthnicityCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Ethnicity Codes summary: Delete EthnicityCode description: Deletes an EthnicityCode operationId: DeleteEthnicityCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ethnicityCode in: path description: Ethnicity Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /ethnicity-codes-batch: put: tags: - Ethnicity Codes summary: Create or Update Batch EthnicityCode description: 'Create or Update multiple EthnicityCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchEthnicityCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/EthnicityCode' text/json: schema: type: array items: $ref: '#/components/schemas/EthnicityCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/EthnicityCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /events: post: tags: - Events summary: Create Event description: Creates a new Event operationId: CreateEvent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Event' text/json: schema: $ref: '#/components/schemas/Event' application/*+json: schema: $ref: '#/components/schemas/Event' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventVBAResponse' application/json: schema: $ref: '#/components/schemas/EventVBAResponse' text/json: schema: $ref: '#/components/schemas/EventVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Events summary: List Event description: Lists all Event operationId: ListEvent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventListVBAResponse' application/json: schema: $ref: '#/components/schemas/EventListVBAResponse' text/json: schema: $ref: '#/components/schemas/EventListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /schedule-intervals: get: tags: - Events summary: List Schedule Intervals description: List Schedule Intervals operationId: ListScheduleIntervals parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /schedule-interval-options: get: tags: - Events summary: List Schedule Interval Options description: List Schedule Interval Options operationId: ListScheduleIntervalOptions parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /schedule-interval-end-options: get: tags: - Events summary: List Schedule Interval End Options description: List Schedule Interval End Options operationId: ListScheduleIntervalEndOptions parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /days-of-week: get: tags: - Events summary: List Days Of Week description: List Days Of Week operationId: ListDaysOfWeek parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /months-of-year: get: tags: - Events summary: List Months Of Year description: List Months Of Year operationId: ListMonthsOfYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /event-actions: get: tags: - Events summary: List Event Actions description: List Event Actions operationId: ListEventActions parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /schedule-actions: get: tags: - Events summary: List Schedule Actions description: List Schedule Actions operationId: ListScheduleActions parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /durations: get: tags: - Events summary: List Durations description: List Durations operationId: ListDurations parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /priorities: get: tags: - Events summary: List Priorities description: List Priorities operationId: ListPriorities parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /snoozes: get: tags: - Events summary: List Snoozes description: List Snoozes operationId: ListSnoozes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userId}/events': get: tags: - Events summary: List Active User Events description: Retrieves a list of active Events for the specified User ID operationId: GetActiveEventsByUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userId in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventListVBAResponse' application/json: schema: $ref: '#/components/schemas/EventListVBAResponse' text/json: schema: $ref: '#/components/schemas/EventListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/events/{eventID}': get: tags: - Events summary: Get Event description: Gets Event operationId: GetEvent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventVBAResponse' application/json: schema: $ref: '#/components/schemas/EventVBAResponse' text/json: schema: $ref: '#/components/schemas/EventVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Events summary: Update Event description: Updates a specific Event. operationId: UpdateEvent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Event' text/json: schema: $ref: '#/components/schemas/Event' application/*+json: schema: $ref: '#/components/schemas/Event' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventVBAResponse' application/json: schema: $ref: '#/components/schemas/EventVBAResponse' text/json: schema: $ref: '#/components/schemas/EventVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Events summary: Delete Event description: Deletes an Event operationId: DeleteEvent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /events-batch: put: tags: - Events summary: Create or Update Batch Event description: 'Create or Update multiple Event at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchEvent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Event' text/json: schema: type: array items: $ref: '#/components/schemas/Event' application/*+json: schema: type: array items: $ref: '#/components/schemas/Event' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/events/{eventID}/reschedule': post: tags: - Events summary: Reschedule Event description: Reschedule Event operationId: RescheduleEvent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventVBAResponse' application/json: schema: $ref: '#/components/schemas/EventVBAResponse' text/json: schema: $ref: '#/components/schemas/EventVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/events/{eventID}/schedules/{scheduleId}/next': post: tags: - Events summary: Next Scheduled Date description: Move Event to the Next Scheduled Date. See ListEventSchedule to get all Schedule IDs for this Event. operationId: NextScheduledDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 - name: scheduleId in: path description: Schedule ID required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/EventScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/EventScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/events/{eventID}/snooze': post: tags: - Events summary: Snooze an Event description: Snooze an Event for the specified duration. See ListSnoozes for available snooze durations. Default snooze duration is 15 minutes. operationId: SnoozeEvent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 - name: snoozeDuration in: query description: Snooze Duration required: true schema: type: string default: SNOOZE_15_MIN responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventVBAResponse' application/json: schema: $ref: '#/components/schemas/EventVBAResponse' text/json: schema: $ref: '#/components/schemas/EventVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-args: get: tags: - Events summary: List Report Args description: List Report Args operationId: ListReportArgs parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/events/{eventID}/args': post: tags: - Event Args summary: Create EventArg description: Creates a new EventArg operationId: CreateEventArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EventArg' text/json: schema: $ref: '#/components/schemas/EventArg' application/*+json: schema: $ref: '#/components/schemas/EventArg' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventArgVBAResponse' application/json: schema: $ref: '#/components/schemas/EventArgVBAResponse' text/json: schema: $ref: '#/components/schemas/EventArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Event Args summary: List EventArg description: Lists all EventArgs for the given EventID operationId: ListEventArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventArgListVBAResponse' application/json: schema: $ref: '#/components/schemas/EventArgListVBAResponse' text/json: schema: $ref: '#/components/schemas/EventArgListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/events/{eventID}/args/{argumentName}': get: tags: - Event Args summary: Get EventArg description: Gets EventArg operationId: GetEventArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 - name: argumentName in: path description: Argument Name required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventArgVBAResponse' application/json: schema: $ref: '#/components/schemas/EventArgVBAResponse' text/json: schema: $ref: '#/components/schemas/EventArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Event Args summary: Update EventArg description: Updates a specific EventArg. operationId: UpdateEventArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 - name: argumentName in: path description: Argument Name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EventArg' text/json: schema: $ref: '#/components/schemas/EventArg' application/*+json: schema: $ref: '#/components/schemas/EventArg' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventArgVBAResponse' application/json: schema: $ref: '#/components/schemas/EventArgVBAResponse' text/json: schema: $ref: '#/components/schemas/EventArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Event Args summary: Delete EventArg description: Deletes an EventArg operationId: DeleteEventArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 - name: argumentName in: path description: Argument Name required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/events/{eventID}/args-batch': put: tags: - Event Args summary: Create or Update Batch EventArg description: 'Create or Update multiple EventArg at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchEventArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/EventArg' text/json: schema: type: array items: $ref: '#/components/schemas/EventArg' application/*+json: schema: type: array items: $ref: '#/components/schemas/EventArg' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/events/{eventID}/schedules': post: tags: - Event Schedules summary: Create EventSchedule description: Creates a new EventSchedule operationId: CreateEventSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EventSchedule' text/json: schema: $ref: '#/components/schemas/EventSchedule' application/*+json: schema: $ref: '#/components/schemas/EventSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/EventScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/EventScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Event Schedules summary: List EventSchedule description: Lists all EventSchedule for a given Event ID operationId: ListEventSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventScheduleListVBAResponse' application/json: schema: $ref: '#/components/schemas/EventScheduleListVBAResponse' text/json: schema: $ref: '#/components/schemas/EventScheduleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/events/{eventID}/schedules/{scheduleID}': get: tags: - Event Schedules summary: Get EventSchedule description: Gets EventSchedule operationId: GetEventSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 - name: scheduleID in: path description: Schedule ID required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/EventScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/EventScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Event Schedules summary: Update EventSchedule description: Updates a specific EventSchedule. operationId: UpdateEventSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 - name: scheduleID in: path description: Schedule ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EventSchedule' text/json: schema: $ref: '#/components/schemas/EventSchedule' application/*+json: schema: $ref: '#/components/schemas/EventSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/EventScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/EventScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/EventScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Event Schedules summary: Delete EventSchedule description: Deletes an EventSchedule operationId: DeleteEventSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 - name: scheduleID in: path description: Schedule ID required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/events/{eventID}/schedules-batch': put: tags: - Event Schedules summary: Create or Update Batch EventSchedule description: 'Create or Update multiple EventSchedule at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchEventSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: eventID in: path description: Event ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/EventSchedule' text/json: schema: type: array items: $ref: '#/components/schemas/EventSchedule' application/*+json: schema: type: array items: $ref: '#/components/schemas/EventSchedule' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /expense-types: post: tags: - Expense Types summary: Create ExpenseType description: Creates a new ExpenseType operationId: CreateExpenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExpenseType' text/json: schema: $ref: '#/components/schemas/ExpenseType' application/*+json: schema: $ref: '#/components/schemas/ExpenseType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExpenseTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ExpenseTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ExpenseTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Expense Types summary: List ExpenseType description: Lists all ExpenseType operationId: ListExpenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExpenseTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ExpenseTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ExpenseTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/expense-types/{expenseType}': get: tags: - Expense Types summary: Get ExpenseType description: Gets ExpenseType operationId: GetExpenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: expenseType in: path description: Expense Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExpenseTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ExpenseTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ExpenseTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Expense Types summary: Update ExpenseType description: Updates a specific ExpenseType. operationId: UpdateExpenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: expenseType in: path description: Expense Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExpenseType' text/json: schema: $ref: '#/components/schemas/ExpenseType' application/*+json: schema: $ref: '#/components/schemas/ExpenseType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExpenseTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ExpenseTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ExpenseTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Expense Types summary: Delete ExpenseType description: Deletes an ExpenseType operationId: DeleteExpenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: expenseType in: path description: Expense Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /expense-types-batch: put: tags: - Expense Types summary: Create or Update Batch ExpenseType description: 'Create or Update multiple ExpenseType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchExpenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ExpenseType' text/json: schema: type: array items: $ref: '#/components/schemas/ExpenseType' application/*+json: schema: type: array items: $ref: '#/components/schemas/ExpenseType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /explaination-code-categories: post: tags: - Explaination Code Categories summary: Create ExplanationCodeCategory description: Creates a new ExplanationCodeCategory operationId: CreateExplanationCodeCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExplanationCodeCategory' text/json: schema: $ref: '#/components/schemas/ExplanationCodeCategory' application/*+json: schema: $ref: '#/components/schemas/ExplanationCodeCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExplanationCodeCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ExplanationCodeCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ExplanationCodeCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Explaination Code Categories summary: List ExplanationCodeCategory description: Lists all ExplanationCodeCategory operationId: ListExplanationCodeCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExplanationCodeCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/ExplanationCodeCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/ExplanationCodeCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/explaination-code-categories/{category}': get: tags: - Explaination Code Categories summary: Get ExplanationCodeCategory description: Gets ExplanationCodeCategory operationId: GetExplanationCodeCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: category in: path description: Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExplanationCodeCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ExplanationCodeCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ExplanationCodeCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Explaination Code Categories summary: Update ExplanationCodeCategory description: Updates a specific ExplanationCodeCategory. operationId: UpdateExplanationCodeCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: category in: path description: Category required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExplanationCodeCategory' text/json: schema: $ref: '#/components/schemas/ExplanationCodeCategory' application/*+json: schema: $ref: '#/components/schemas/ExplanationCodeCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExplanationCodeCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ExplanationCodeCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ExplanationCodeCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Explaination Code Categories summary: Delete ExplanationCodeCategory description: Deletes an ExplanationCodeCategory operationId: DeleteExplanationCodeCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: category in: path description: Category required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /explaination-code-categories-batch: put: tags: - Explaination Code Categories summary: Create or Update Batch ExplanationCodeCategory description: 'Create or Update multiple ExplanationCodeCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchExplanationCodeCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ExplanationCodeCategory' text/json: schema: type: array items: $ref: '#/components/schemas/ExplanationCodeCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/ExplanationCodeCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /ex-codes: post: tags: - Explanation Codes summary: Create ExplanationCodes description: Creates a new ExplanationCodes operationId: CreateExplanationCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExplanationCodes' text/json: schema: $ref: '#/components/schemas/ExplanationCodes' application/*+json: schema: $ref: '#/components/schemas/ExplanationCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExplanationCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/ExplanationCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/ExplanationCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Explanation Codes summary: List ExplanationCodes description: Lists all ExplanationCodes operationId: ListExplanationCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExplanationCodesListVBAResponse' application/json: schema: $ref: '#/components/schemas/ExplanationCodesListVBAResponse' text/json: schema: $ref: '#/components/schemas/ExplanationCodesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/ex-codes/{exCode}': get: tags: - Explanation Codes summary: Get ExplanationCodes description: Gets ExplanationCodes operationId: GetExplanationCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: exCode in: path description: Ex Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExplanationCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/ExplanationCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/ExplanationCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Explanation Codes summary: Update ExplanationCodes description: Updates a specific ExplanationCodes. operationId: UpdateExplanationCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: exCode in: path description: Ex Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExplanationCodes' text/json: schema: $ref: '#/components/schemas/ExplanationCodes' application/*+json: schema: $ref: '#/components/schemas/ExplanationCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExplanationCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/ExplanationCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/ExplanationCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Explanation Codes summary: Delete ExplanationCodes description: Deletes an ExplanationCodes operationId: DeleteExplanationCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: exCode in: path description: Ex Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /ex-codes-batch: put: tags: - Explanation Codes summary: Create or Update Batch ExplanationCodes description: 'Create or Update multiple ExplanationCodes at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchExplanationCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ExplanationCodes' text/json: schema: type: array items: $ref: '#/components/schemas/ExplanationCodes' application/*+json: schema: type: array items: $ref: '#/components/schemas/ExplanationCodes' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /external-ids: post: tags: - External ID summary: Create ExternalID description: Creates a new ExternalID operationId: CreateExternalID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExternalID' text/json: schema: $ref: '#/components/schemas/ExternalID' application/*+json: schema: $ref: '#/components/schemas/ExternalID' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExternalIDVBAResponse' application/json: schema: $ref: '#/components/schemas/ExternalIDVBAResponse' text/json: schema: $ref: '#/components/schemas/ExternalIDVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - External ID summary: List ExternalID description: Lists all ExternalID operationId: ListExternalID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExternalIDListVBAResponse' application/json: schema: $ref: '#/components/schemas/ExternalIDListVBAResponse' text/json: schema: $ref: '#/components/schemas/ExternalIDListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/external-ids/{externalId}': get: tags: - External ID summary: Get ExternalID description: Gets ExternalID operationId: GetExternalID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: externalId in: path description: External ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExternalIDVBAResponse' application/json: schema: $ref: '#/components/schemas/ExternalIDVBAResponse' text/json: schema: $ref: '#/components/schemas/ExternalIDVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - External ID summary: Update ExternalID description: Updates a specific ExternalID. operationId: UpdateExternalID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: externalId in: path description: External ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExternalID' text/json: schema: $ref: '#/components/schemas/ExternalID' application/*+json: schema: $ref: '#/components/schemas/ExternalID' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExternalIDVBAResponse' application/json: schema: $ref: '#/components/schemas/ExternalIDVBAResponse' text/json: schema: $ref: '#/components/schemas/ExternalIDVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - External ID summary: Delete ExternalID description: Deletes an ExternalID operationId: DeleteExternalID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: externalId in: path description: External ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /external-ids-batch: put: tags: - External ID summary: Create or Update Batch ExternalID description: 'Create or Update multiple ExternalID at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchExternalID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ExternalID' text/json: schema: type: array items: $ref: '#/components/schemas/ExternalID' application/*+json: schema: type: array items: $ref: '#/components/schemas/ExternalID' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /feedback: post: tags: - Feedback summary: Create Feedback description: Submits Feedback for the VBA application. operationId: CreateFeedback parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Feedback' text/json: schema: $ref: '#/components/schemas/Feedback' application/*+json: schema: $ref: '#/components/schemas/Feedback' required: true responses: '202': description: Accepted content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedules: post: tags: - Fee Schedules summary: Create FeeSched description: Creates a new FeeSched operationId: CreateFeeSched parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSched' text/json: schema: $ref: '#/components/schemas/FeeSched' application/*+json: schema: $ref: '#/components/schemas/FeeSched' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Fee Schedules summary: List FeeSched description: Lists all FeeSched operationId: ListFeeSched parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedListVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedListVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedule-copy: post: tags: - Fee Schedules - Adv. FeeSchedule summary: Copy Fee Schedule description: Copy an existing Fee Schedule to a new Fee Schedule. operationId: CopyFeeSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedCopy' text/json: schema: $ref: '#/components/schemas/FeeSchedCopy' application/*+json: schema: $ref: '#/components/schemas/FeeSchedCopy' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /fee-schedule-copy-adj-disc: post: tags: - Fee Schedules - Adv. FeeSchedule summary: Copy Fee Schedule and Adjust Discount description: Copy an existing Fee Schedule to a new Fee Schedule and adjust the resulting discount in the new Fee Schedule. operationId: CopyFeeScheduleAdjDisc parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedCopy' text/json: schema: $ref: '#/components/schemas/FeeSchedCopy' application/*+json: schema: $ref: '#/components/schemas/FeeSchedCopy' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/fee-schedules/{feeSched}': get: tags: - Fee Schedules summary: Get FeeSched description: Gets FeeSched operationId: GetFeeSched parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSched in: path description: Fee Sched required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Fee Schedules summary: Update FeeSched description: Updates a specific FeeSched. operationId: UpdateFeeSched parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSched in: path description: Fee Sched required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSched' text/json: schema: $ref: '#/components/schemas/FeeSched' application/*+json: schema: $ref: '#/components/schemas/FeeSched' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Fee Schedules summary: Delete FeeSched description: Deletes an FeeSched operationId: DeleteFeeSched parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSched in: path description: Fee Sched required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedules-batch: put: tags: - Fee Schedules summary: Create or Update Batch FeeSched description: 'Create or Update multiple FeeSched at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFeeSched parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FeeSched' text/json: schema: type: array items: $ref: '#/components/schemas/FeeSched' application/*+json: schema: type: array items: $ref: '#/components/schemas/FeeSched' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /usual-customary-rate: get: tags: - Fee Schedules summary: List Usual and Customary Rates description: Lists all UC Rates based on provided criteria. operationId: ListUCRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimType in: query description: Claim Type schema: type: string - name: serviceDate in: query description: Service Date schema: type: string format: date-time - name: zipStart in: query description: Zip Code From schema: type: string - name: zipEnd in: query description: Zip Code Thru schema: type: string - name: procStart in: query description: Procedure Code From schema: type: string - name: procEnd in: query description: Procedure Code Thru schema: type: string - name: modifier in: query description: Modifier schema: type: string - name: percentile in: query description: Percentile schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UsualCustomaryRateAllPercentileListVBAResponse' application/json: schema: $ref: '#/components/schemas/UsualCustomaryRateAllPercentileListVBAResponse' text/json: schema: $ref: '#/components/schemas/UsualCustomaryRateAllPercentileListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedule-anesthesias: post: tags: - Fee Schedule Anesthesias summary: Create FeeSchedAnesthesia description: Creates a new FeeSchedAnesthesia operationId: CreateFeeSchedAnesthesia parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedAnesthesia' text/json: schema: $ref: '#/components/schemas/FeeSchedAnesthesia' application/*+json: schema: $ref: '#/components/schemas/FeeSchedAnesthesia' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedAnesthesiaVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedAnesthesiaVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedAnesthesiaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Fee Schedule Anesthesias summary: List FeeSchedAnesthesia description: Lists all FeeSchedAnesthesia operationId: ListFeeSchedAnesthesia parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedAnesthesiaListVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedAnesthesiaListVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedAnesthesiaListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/fee-schedule-anesthesias/{feeSchedAnesthesiaKey}': get: tags: - Fee Schedule Anesthesias summary: Get FeeSchedAnesthesia description: Gets FeeSchedAnesthesia operationId: GetFeeSchedAnesthesia parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedAnesthesiaKey in: path description: FeeSchedAnesthesia Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedAnesthesiaVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedAnesthesiaVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedAnesthesiaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Fee Schedule Anesthesias summary: Update FeeSchedAnesthesia description: Updates a specific FeeSchedAnesthesia. operationId: UpdateFeeSchedAnesthesia parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedAnesthesiaKey in: path description: FeeSchedAnesthesia Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedAnesthesia' text/json: schema: $ref: '#/components/schemas/FeeSchedAnesthesia' application/*+json: schema: $ref: '#/components/schemas/FeeSchedAnesthesia' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedAnesthesiaVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedAnesthesiaVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedAnesthesiaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Fee Schedule Anesthesias summary: Delete FeeSchedAnesthesia description: Deletes an FeeSchedAnesthesia operationId: DeleteFeeSchedAnesthesia parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedAnesthesiaKey in: path description: FeeSchedAnesthesia Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedule-anesthesias-batch: put: tags: - Fee Schedule Anesthesias summary: Create or Update Batch FeeSchedAnesthesia description: 'Create or Update multiple FeeSchedAnesthesia at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFeeSchedAnesthesia parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedAnesthesia' text/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedAnesthesia' application/*+json: schema: type: array items: $ref: '#/components/schemas/FeeSchedAnesthesia' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedule-details: post: tags: - Fee Schedule Details summary: Create FeeSchedDetail description: Creates a new FeeSchedDetail operationId: CreateFeeSchedDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedDetail' text/json: schema: $ref: '#/components/schemas/FeeSchedDetail' application/*+json: schema: $ref: '#/components/schemas/FeeSchedDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Fee Schedule Details summary: List FeeSchedDetail description: Lists all FeeSchedDetail operationId: ListFeeSchedDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/fee-schedule-details/{feeSchedDetailKey}': get: tags: - Fee Schedule Details summary: Get FeeSchedDetail description: Gets FeeSchedDetail operationId: GetFeeSchedDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedDetailKey in: path description: FeeSchedDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Fee Schedule Details summary: Update FeeSchedDetail description: Updates a specific FeeSchedDetail. operationId: UpdateFeeSchedDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedDetailKey in: path description: FeeSchedDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedDetail' text/json: schema: $ref: '#/components/schemas/FeeSchedDetail' application/*+json: schema: $ref: '#/components/schemas/FeeSchedDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Fee Schedule Details summary: Delete FeeSchedDetail description: Deletes an FeeSchedDetail operationId: DeleteFeeSchedDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedDetailKey in: path description: FeeSchedDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedule-details-batch: put: tags: - Fee Schedule Details summary: Create or Update Batch FeeSchedDetail description: 'Create or Update multiple FeeSchedDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFeeSchedDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedDetail' text/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/FeeSchedDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/fee-schedules/{feeSched}/effective-dates': post: tags: - Fee Schedule Effective Dates summary: Create FeeSchedEffDate description: Creates a new FeeSchedEffDate operationId: CreateFeeSchedEffDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSched in: path description: Fee Sched required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedEffDate' text/json: schema: $ref: '#/components/schemas/FeeSchedEffDate' application/*+json: schema: $ref: '#/components/schemas/FeeSchedEffDate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedEffDateVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedEffDateVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedEffDateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Fee Schedule Effective Dates summary: List FeeSchedEffDate description: Lists all FeeSchedEffDate for the given feeSched operationId: ListFeeSchedEffDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSched in: path description: Fee Sched required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedEffDateListVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedEffDateListVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedEffDateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/fee-schedules/{feeSched}/effective-dates/{effectiveDate}': get: tags: - Fee Schedule Effective Dates summary: Get FeeSchedEffDate description: Gets FeeSchedEffDate operationId: GetFeeSchedEffDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSched in: path description: Fee Sched required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedEffDateVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedEffDateVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedEffDateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Fee Schedule Effective Dates summary: Delete FeeSchedEffDate description: Deletes an FeeSchedEffDate operationId: DeleteFeeSchedEffDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSched in: path description: Fee Sched required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/fee-schedules/{feeSched}/effective-dates-batch': put: tags: - Fee Schedule Effective Dates summary: Create Batch FeeSchedEffDate description: 'Create multiple FeeSchedEffDate at once. If the entity does not exist, it will be created. If the entity exists, an error message will be returned for that id.' operationId: UpdateBatchFeeSchedEffDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSched in: path description: Fee Sched required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedEffDate' text/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedEffDate' application/*+json: schema: type: array items: $ref: '#/components/schemas/FeeSchedEffDate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedule-modifier-discounts: post: tags: - Fee Schedule Modifier Discounts summary: Create FeeSchedModifierDiscount description: Creates a new FeeSchedModifierDiscount operationId: CreateFeeSchedModifierDiscount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscount' text/json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscount' application/*+json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedModifierDiscountVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscountVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Fee Schedule Modifier Discounts summary: List FeeSchedModifierDiscount description: Lists all FeeSchedModifierDiscount operationId: ListFeeSchedModifierDiscount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedModifierDiscountListVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscountListVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscountListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/fee-schedule-modifier-discounts/{feeSchedModifierDiscountKey}': get: tags: - Fee Schedule Modifier Discounts summary: Get FeeSchedModifierDiscount description: Gets FeeSchedModifierDiscount operationId: GetFeeSchedModifierDiscount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedModifierDiscountKey in: path description: FeeSchedModifierDiscount Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedModifierDiscountVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscountVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Fee Schedule Modifier Discounts summary: Update FeeSchedModifierDiscount description: Updates a specific FeeSchedModifierDiscount. operationId: UpdateFeeSchedModifierDiscount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedModifierDiscountKey in: path description: FeeSchedModifierDiscount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscount' text/json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscount' application/*+json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedModifierDiscountVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscountVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedModifierDiscountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Fee Schedule Modifier Discounts summary: Delete FeeSchedModifierDiscount description: Deletes an FeeSchedModifierDiscount operationId: DeleteFeeSchedModifierDiscount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedModifierDiscountKey in: path description: FeeSchedModifierDiscount Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedule-modifier-discounts-batch: put: tags: - Fee Schedule Modifier Discounts summary: Create or Update Batch FeeSchedModifierDiscount description: 'Create or Update multiple FeeSchedModifierDiscount at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFeeSchedModifierDiscount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedModifierDiscount' text/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedModifierDiscount' application/*+json: schema: type: array items: $ref: '#/components/schemas/FeeSchedModifierDiscount' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedule-modifier-excludes: post: tags: - Fee Schedule Modifier Excludes summary: Create FeeSchedModifierExclude description: Creates a new FeeSchedModifierExclude operationId: CreateFeeSchedModifierExclude parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedModifierExclude' text/json: schema: $ref: '#/components/schemas/FeeSchedModifierExclude' application/*+json: schema: $ref: '#/components/schemas/FeeSchedModifierExclude' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedModifierExcludeVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedModifierExcludeVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedModifierExcludeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Fee Schedule Modifier Excludes summary: List FeeSchedModifierExclude description: Lists all FeeSchedModifierExclude operationId: ListFeeSchedModifierExclude parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedModifierExcludeListVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedModifierExcludeListVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedModifierExcludeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/fee-schedule-modifier-excludes/{feeSchedModifierExcludeKey}': get: tags: - Fee Schedule Modifier Excludes summary: Get FeeSchedModifierExclude description: Gets FeeSchedModifierExclude operationId: GetFeeSchedModifierExclude parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedModifierExcludeKey in: path description: FeeSchedModifierExclude Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedModifierExcludeVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedModifierExcludeVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedModifierExcludeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Fee Schedule Modifier Excludes summary: Update FeeSchedModifierExclude description: Updates a specific FeeSchedModifierExclude. operationId: UpdateFeeSchedModifierExclude parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedModifierExcludeKey in: path description: FeeSchedModifierExclude Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedModifierExclude' text/json: schema: $ref: '#/components/schemas/FeeSchedModifierExclude' application/*+json: schema: $ref: '#/components/schemas/FeeSchedModifierExclude' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedModifierExcludeVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedModifierExcludeVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedModifierExcludeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Fee Schedule Modifier Excludes summary: Delete FeeSchedModifierExclude description: Deletes an FeeSchedModifierExclude operationId: DeleteFeeSchedModifierExclude parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedModifierExcludeKey in: path description: FeeSchedModifierExclude Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedule-modifier-excludes-batch: put: tags: - Fee Schedule Modifier Excludes summary: Create or Update Batch FeeSchedModifierExclude description: 'Create or Update multiple FeeSchedModifierExclude at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFeeSchedModifierExclude parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedModifierExclude' text/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedModifierExclude' application/*+json: schema: type: array items: $ref: '#/components/schemas/FeeSchedModifierExclude' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedule-procedure-group-adjustments: post: tags: - Fee Schedule Procedure Group Adjustments summary: Create FeeSchedProcedureGroupAdjust description: Creates a new FeeSchedProcedureGroupAdjust operationId: CreateFeeSchedProcedureGroupAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjust' text/json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjust' application/*+json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjust' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjustVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjustVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjustVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Fee Schedule Procedure Group Adjustments summary: List FeeSchedProcedureGroupAdjust description: Lists all FeeSchedProcedureGroupAdjust operationId: ListFeeSchedProcedureGroupAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjustListVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjustListVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjustListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/fee-schedule-procedure-group-adjustments/{feeSchedProcedureGroupAdjustKey}': get: tags: - Fee Schedule Procedure Group Adjustments summary: Get FeeSchedProcedureGroupAdjust description: Gets FeeSchedProcedureGroupAdjust operationId: GetFeeSchedProcedureGroupAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedProcedureGroupAdjustKey in: path description: FeeSchedProcedureGroupAdjust Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjustVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjustVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjustVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Fee Schedule Procedure Group Adjustments summary: Update FeeSchedProcedureGroupAdjust description: Updates a specific FeeSchedProcedureGroupAdjust. operationId: UpdateFeeSchedProcedureGroupAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedProcedureGroupAdjustKey in: path description: FeeSchedProcedureGroupAdjust Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjust' text/json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjust' application/*+json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjust' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjustVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjustVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjustVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Fee Schedule Procedure Group Adjustments summary: Delete FeeSchedProcedureGroupAdjust description: Deletes an FeeSchedProcedureGroupAdjust operationId: DeleteFeeSchedProcedureGroupAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedProcedureGroupAdjustKey in: path description: FeeSchedProcedureGroupAdjust Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedule-procedure-group-adjustments-batch: put: tags: - Fee Schedule Procedure Group Adjustments summary: Create or Update Batch FeeSchedProcedureGroupAdjust description: 'Create or Update multiple FeeSchedProcedureGroupAdjust at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFeeSchedProcedureGroupAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjust' text/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjust' application/*+json: schema: type: array items: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjust' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedule-provider-type-discounts: post: tags: - Fee Schedule Provider Type Discounts summary: Create FeeSchedProviderTypeDiscount description: Creates a new FeeSchedProviderTypeDiscount operationId: CreateFeeSchedProviderTypeDiscount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscount' text/json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscount' application/*+json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscountVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscountVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Fee Schedule Provider Type Discounts summary: List FeeSchedProviderTypeDiscount description: Lists all FeeSchedProviderTypeDiscount operationId: ListFeeSchedProviderTypeDiscount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscountListVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscountListVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscountListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/fee-schedule-provider-type-discounts/{feeSchedProviderTypeDiscountKey}': get: tags: - Fee Schedule Provider Type Discounts summary: Get FeeSchedProviderTypeDiscount description: Gets FeeSchedProviderTypeDiscount operationId: GetFeeSchedProviderTypeDiscount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedProviderTypeDiscountKey in: path description: FeeSchedProviderTypeDiscount Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscountVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscountVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Fee Schedule Provider Type Discounts summary: Update FeeSchedProviderTypeDiscount description: Updates a specific FeeSchedProviderTypeDiscount. operationId: UpdateFeeSchedProviderTypeDiscount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedProviderTypeDiscountKey in: path description: FeeSchedProviderTypeDiscount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscount' text/json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscount' application/*+json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscountVBAResponse' application/json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscountVBAResponse' text/json: schema: $ref: '#/components/schemas/FeeSchedProviderTypeDiscountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Fee Schedule Provider Type Discounts summary: Delete FeeSchedProviderTypeDiscount description: Deletes an FeeSchedProviderTypeDiscount operationId: DeleteFeeSchedProviderTypeDiscount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: feeSchedProviderTypeDiscountKey in: path description: FeeSchedProviderTypeDiscount Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /fee-schedule-provider-type-discounts-batch: put: tags: - Fee Schedule Provider Type Discounts summary: Create or Update Batch FeeSchedProviderTypeDiscount description: 'Create or Update multiple FeeSchedProviderTypeDiscount at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFeeSchedProviderTypeDiscount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedProviderTypeDiscount' text/json: schema: type: array items: $ref: '#/components/schemas/FeeSchedProviderTypeDiscount' application/*+json: schema: type: array items: $ref: '#/components/schemas/FeeSchedProviderTypeDiscount' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /filters: post: tags: - Filters summary: Create Filter description: Creates a new Filter operationId: CreateFilter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Filter' text/json: schema: $ref: '#/components/schemas/Filter' application/*+json: schema: $ref: '#/components/schemas/Filter' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FilterVBAResponse' application/json: schema: $ref: '#/components/schemas/FilterVBAResponse' text/json: schema: $ref: '#/components/schemas/FilterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Filters summary: List Filter description: Lists all Filter operationId: ListFilter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FilterListVBAResponse' application/json: schema: $ref: '#/components/schemas/FilterListVBAResponse' text/json: schema: $ref: '#/components/schemas/FilterListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/filters/{filterKey}': get: tags: - Filters summary: Get Filter description: Gets Filter operationId: GetFilter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: filterKey in: path description: Filter Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FilterVBAResponse' application/json: schema: $ref: '#/components/schemas/FilterVBAResponse' text/json: schema: $ref: '#/components/schemas/FilterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Filters summary: Update Filter description: Updates a specific Filter. operationId: UpdateFilter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: filterKey in: path description: Filter Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Filter' text/json: schema: $ref: '#/components/schemas/Filter' application/*+json: schema: $ref: '#/components/schemas/Filter' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FilterVBAResponse' application/json: schema: $ref: '#/components/schemas/FilterVBAResponse' text/json: schema: $ref: '#/components/schemas/FilterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Filters summary: Delete Filter description: Deletes an Filter operationId: DeleteFilter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: filterKey in: path description: Filter Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /filters-batch: put: tags: - Filters summary: Create or Update Batch Filter description: 'Create or Update multiple Filter at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFilter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Filter' text/json: schema: type: array items: $ref: '#/components/schemas/Filter' application/*+json: schema: type: array items: $ref: '#/components/schemas/Filter' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /filter-types: post: tags: - Filter Types summary: Create FilterType description: Creates a new FilterType operationId: CreateFilterType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FilterType' text/json: schema: $ref: '#/components/schemas/FilterType' application/*+json: schema: $ref: '#/components/schemas/FilterType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FilterTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FilterTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FilterTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Filter Types summary: List FilterType description: Lists all FilterType operationId: ListFilterType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FilterTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/FilterTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/FilterTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/filter-types/{filterType}': get: tags: - Filter Types summary: Get FilterType description: Gets FilterType operationId: GetFilterType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: filterType in: path description: Filter Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FilterTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FilterTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FilterTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Filter Types summary: Update FilterType description: Updates a specific FilterType. operationId: UpdateFilterType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: filterType in: path description: Filter Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FilterType' text/json: schema: $ref: '#/components/schemas/FilterType' application/*+json: schema: $ref: '#/components/schemas/FilterType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FilterTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FilterTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FilterTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Filter Types summary: Delete FilterType description: Deletes an FilterType operationId: DeleteFilterType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: filterType in: path description: Filter Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /filter-types-batch: put: tags: - Filter Types summary: Create or Update Batch FilterType description: 'Create or Update multiple FilterType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFilterType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FilterType' text/json: schema: type: array items: $ref: '#/components/schemas/FilterType' application/*+json: schema: type: array items: $ref: '#/components/schemas/FilterType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-vendors/{flexVendor}/issuance-types': post: tags: - Flex Issuance Types summary: Create FlexIssuanceType description: Creates a new FlexIssuanceType operationId: CreateFlexIssuanceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlexIssuanceType' text/json: schema: $ref: '#/components/schemas/FlexIssuanceType' application/*+json: schema: $ref: '#/components/schemas/FlexIssuanceType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexIssuanceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexIssuanceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexIssuanceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Flex Issuance Types summary: List FlexIssuanceType description: Lists all FlexIssuanceType for the given flexVendor operationId: ListFlexIssuanceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexIssuanceTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexIssuanceTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexIssuanceTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-vendors/{flexVendor}/issuance-types/{issuanceType}': get: tags: - Flex Issuance Types summary: Get FlexIssuanceType description: Gets FlexIssuanceType operationId: GetFlexIssuanceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string - name: issuanceType in: path description: Issuance Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexIssuanceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexIssuanceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexIssuanceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Flex Issuance Types summary: Update FlexIssuanceType description: Updates a specific FlexIssuanceType. operationId: UpdateFlexIssuanceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string - name: issuanceType in: path description: Issuance Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlexIssuanceType' text/json: schema: $ref: '#/components/schemas/FlexIssuanceType' application/*+json: schema: $ref: '#/components/schemas/FlexIssuanceType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexIssuanceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexIssuanceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexIssuanceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Flex Issuance Types summary: Delete FlexIssuanceType description: Deletes an FlexIssuanceType operationId: DeleteFlexIssuanceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string - name: issuanceType in: path description: Issuance Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-vendors/{flexVendor}/issuance-types-batch': put: tags: - Flex Issuance Types summary: Create or Update Batch FlexIssuanceType description: 'Create or Update multiple FlexIssuanceType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFlexIssuanceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FlexIssuanceType' text/json: schema: type: array items: $ref: '#/components/schemas/FlexIssuanceType' application/*+json: schema: type: array items: $ref: '#/components/schemas/FlexIssuanceType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /flex-vendors: post: tags: - Flex Vendors summary: Create FlexVendor description: Creates a new FlexVendor operationId: CreateFlexVendor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlexVendor' text/json: schema: $ref: '#/components/schemas/FlexVendor' application/*+json: schema: $ref: '#/components/schemas/FlexVendor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexVendorVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexVendorVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexVendorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Flex Vendors summary: List FlexVendor description: Lists all FlexVendor operationId: ListFlexVendor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexVendorListVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexVendorListVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexVendorListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-vendors/{flexVendor}': get: tags: - Flex Vendors summary: Get FlexVendor description: Gets FlexVendor operationId: GetFlexVendor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexVendorVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexVendorVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexVendorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Flex Vendors summary: Update FlexVendor description: Updates a specific FlexVendor. operationId: UpdateFlexVendor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlexVendor' text/json: schema: $ref: '#/components/schemas/FlexVendor' application/*+json: schema: $ref: '#/components/schemas/FlexVendor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexVendorVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexVendorVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexVendorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Flex Vendors summary: Delete FlexVendor description: Deletes an FlexVendor operationId: DeleteFlexVendor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /flex-vendors-batch: put: tags: - Flex Vendors summary: Create or Update Batch FlexVendor description: 'Create or Update multiple FlexVendor at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFlexVendor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FlexVendor' text/json: schema: type: array items: $ref: '#/components/schemas/FlexVendor' application/*+json: schema: type: array items: $ref: '#/components/schemas/FlexVendor' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-vendors/{flexVendor}/card-statuses': post: tags: - Flex Vendor Card Status summary: Create FlexVendorCardStatus description: Creates a new FlexVendorCardStatus operationId: CreateFlexVendorCardStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlexVendorCardStatus' text/json: schema: $ref: '#/components/schemas/FlexVendorCardStatus' application/*+json: schema: $ref: '#/components/schemas/FlexVendorCardStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexVendorCardStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexVendorCardStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexVendorCardStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Flex Vendor Card Status summary: List FlexVendorCardStatus description: Lists all FlexVendorCardStatus for the given flexVendor operationId: ListFlexVendorCardStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexVendorCardStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexVendorCardStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexVendorCardStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-vendors/{flexVendor}/card-statuses/{cardStatus}': get: tags: - Flex Vendor Card Status summary: Get FlexVendorCardStatus description: Gets FlexVendorCardStatus operationId: GetFlexVendorCardStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string - name: cardStatus in: path description: Card Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexVendorCardStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexVendorCardStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexVendorCardStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Flex Vendor Card Status summary: Update FlexVendorCardStatus description: Updates a specific FlexVendorCardStatus. operationId: UpdateFlexVendorCardStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string - name: cardStatus in: path description: Card Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlexVendorCardStatus' text/json: schema: $ref: '#/components/schemas/FlexVendorCardStatus' application/*+json: schema: $ref: '#/components/schemas/FlexVendorCardStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexVendorCardStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexVendorCardStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexVendorCardStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Flex Vendor Card Status summary: Delete FlexVendorCardStatus description: Deletes an FlexVendorCardStatus operationId: DeleteFlexVendorCardStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string - name: cardStatus in: path description: Card Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-vendors/{flexVendor}/card-statuses-batch': put: tags: - Flex Vendor Card Status summary: Create or Update Batch FlexVendorCardStatus description: 'Create or Update multiple FlexVendorCardStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFlexVendorCardStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FlexVendorCardStatus' text/json: schema: type: array items: $ref: '#/components/schemas/FlexVendorCardStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/FlexVendorCardStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-vendors/{flexVendor}/purse-statuses': post: tags: - Flex Vendor Purse Status summary: Create FlexVendorPurseStatus description: Creates a new FlexVendorPurseStatus operationId: CreateFlexVendorPurseStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlexVendorPurseStatus' text/json: schema: $ref: '#/components/schemas/FlexVendorPurseStatus' application/*+json: schema: $ref: '#/components/schemas/FlexVendorPurseStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexVendorPurseStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexVendorPurseStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexVendorPurseStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Flex Vendor Purse Status summary: List FlexVendorPurseStatus description: Lists all FlexVendorPurseStatus for the given flexVendor operationId: ListFlexVendorPurseStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexVendorPurseStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexVendorPurseStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexVendorPurseStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-vendors/{flexVendor}/purse-statuses/{purseStatus}': get: tags: - Flex Vendor Purse Status summary: Get FlexVendorPurseStatus description: Gets FlexVendorPurseStatus operationId: GetFlexVendorPurseStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string - name: purseStatus in: path description: Purse Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexVendorPurseStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexVendorPurseStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexVendorPurseStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Flex Vendor Purse Status summary: Update FlexVendorPurseStatus description: Updates a specific FlexVendorPurseStatus. operationId: UpdateFlexVendorPurseStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string - name: purseStatus in: path description: Purse Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlexVendorPurseStatus' text/json: schema: $ref: '#/components/schemas/FlexVendorPurseStatus' application/*+json: schema: $ref: '#/components/schemas/FlexVendorPurseStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FlexVendorPurseStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FlexVendorPurseStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FlexVendorPurseStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Flex Vendor Purse Status summary: Delete FlexVendorPurseStatus description: Deletes an FlexVendorPurseStatus operationId: DeleteFlexVendorPurseStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string - name: purseStatus in: path description: Purse Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/flex-vendors/{flexVendor}/purse-statuses-batch': put: tags: - Flex Vendor Purse Status summary: Create or Update Batch FlexVendorPurseStatus description: 'Create or Update multiple FlexVendorPurseStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFlexVendorPurseStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: flexVendor in: path description: Flex Vendor required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FlexVendorPurseStatus' text/json: schema: type: array items: $ref: '#/components/schemas/FlexVendorPurseStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/FlexVendorPurseStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /forfeiture-statuses: post: tags: - Forfeiture Statuses summary: Create ForfeitureStatus description: Creates a new ForfeitureStatus operationId: CreateForfeitureStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ForfeitureStatus' text/json: schema: $ref: '#/components/schemas/ForfeitureStatus' application/*+json: schema: $ref: '#/components/schemas/ForfeitureStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ForfeitureStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ForfeitureStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ForfeitureStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Forfeiture Statuses summary: List ForfeitureStatus description: 'Lists all ForfeitureStatus ' operationId: ListForfeitureStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ForfeitureStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ForfeitureStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ForfeitureStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/forfeiture-statuses/{forfeitureStatus}': get: tags: - Forfeiture Statuses summary: Get ForfeitureStatus description: Gets ForfeitureStatus operationId: GetForfeitureStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: forfeitureStatus in: path description: Forfeiture Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ForfeitureStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ForfeitureStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ForfeitureStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Forfeiture Statuses summary: Update ForfeitureStatus description: Updates a specific ForfeitureStatus. operationId: UpdateForfeitureStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: forfeitureStatus in: path description: Forfeiture Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ForfeitureStatus' text/json: schema: $ref: '#/components/schemas/ForfeitureStatus' application/*+json: schema: $ref: '#/components/schemas/ForfeitureStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ForfeitureStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ForfeitureStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ForfeitureStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Forfeiture Statuses summary: Delete ForfeitureStatus description: Deletes an ForfeitureStatus operationId: DeleteForfeitureStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: forfeitureStatus in: path description: Forfeiture Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /forfeiture-statuses-batch: put: tags: - Forfeiture Statuses summary: Create or Update Batch ForfeitureStatus description: 'Create or Update multiple ForfeitureStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchForfeitureStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ForfeitureStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ForfeitureStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ForfeitureStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /functional-areas: get: tags: - Objects summary: List Functional Areas description: Gets a list of all Functional Areas operationId: ListFunctionalAreas parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FunctionalAreaListVBAResponse' application/json: schema: $ref: '#/components/schemas/FunctionalAreaListVBAResponse' text/json: schema: $ref: '#/components/schemas/FunctionalAreaListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding: post: tags: - Funding summary: Create Funding description: Creates a new Funding operationId: CreateFunding parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Funding' text/json: schema: $ref: '#/components/schemas/Funding' application/*+json: schema: $ref: '#/components/schemas/Funding' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding summary: List Funding description: Lists all Funding operationId: ListFunding parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding/{fundingKey}': get: tags: - Funding summary: Get Funding description: Gets Funding operationId: GetFunding parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingKey in: path description: Funding Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding summary: Update Funding description: Updates a specific Funding. operationId: UpdateFunding parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingKey in: path description: Funding Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Funding' text/json: schema: $ref: '#/components/schemas/Funding' application/*+json: schema: $ref: '#/components/schemas/Funding' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding summary: Delete Funding description: Deletes an Funding operationId: DeleteFunding parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingKey in: path description: Funding Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding/{fundingKey}/hold': post: tags: - Funding - Adv. Accounting summary: Hold Funds description: Lower the existing funding item by the hold amount and create a new funding for the hold amount. operationId: HoldFunds parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingKey in: path description: Funding Key required: true schema: type: integer format: int32 requestBody: content: multipart/form-data: schema: required: - holdAmount type: object properties: holdAmount: type: number format: double encoding: holdAmount: style: form responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/funding/{fundingKey}/payors/{payorId}/accounts/{accountKey}/reallocate': put: tags: - Funding - Adv. Accounting summary: Reacllocate Funds description: Change the Payor ID and Account Key of an existing funding item. operationId: ReallocateFunds parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingKey in: path description: Funding Key required: true schema: type: integer format: int32 - name: payorId in: path description: Payor ID required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/funding/{fundingKey}/void': put: tags: - Funding - Adv. Accounting summary: Void Funds description: Void an existing funding item. operationId: VoidFunds parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingKey in: path description: Funding Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/funding/{fundingKey}/transfer': put: tags: - Funding - Adv. Accounting summary: Transfer Funds description: 'Transfer funds from one account to another. Additionally, can auto-create a premium distribution if a Funding_Key of 0 is sent.' operationId: TransferFunds parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingKey in: path description: Funding Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingTransferFunds' text/json: schema: $ref: '#/components/schemas/FundingTransferFunds' application/*+json: schema: $ref: '#/components/schemas/FundingTransferFunds' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /funding-batch: put: tags: - Funding summary: Create or Update Batch Funding description: 'Create or Update multiple Funding at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFunding parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Funding' text/json: schema: type: array items: $ref: '#/components/schemas/Funding' application/*+json: schema: type: array items: $ref: '#/components/schemas/Funding' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-accounts: post: tags: - Funding Account summary: Create FundingAccount description: Creates a new FundingAccount operationId: CreateFundingAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingAccount' text/json: schema: $ref: '#/components/schemas/FundingAccount' application/*+json: schema: $ref: '#/components/schemas/FundingAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Account summary: List FundingAccount description: Lists all FundingAccount operationId: ListFundingAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-accounts/{accountKey}': get: tags: - Funding Account summary: Get FundingAccount description: Gets FundingAccount operationId: GetFundingAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Account summary: Update FundingAccount description: Updates a specific FundingAccount. operationId: UpdateFundingAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingAccount' text/json: schema: $ref: '#/components/schemas/FundingAccount' application/*+json: schema: $ref: '#/components/schemas/FundingAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Account summary: Delete FundingAccount description: Deletes an FundingAccount operationId: DeleteFundingAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-accounts/{accountKey}/account-balance': get: tags: - Funding Account - Adv. Accounting summary: Get FundingAccount Balance description: Gets FundingAccount balance details operationId: GetFundingAccountBalance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountBalanceVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountBalanceVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountBalanceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /funding-accounts-batch: put: tags: - Funding Account summary: Create or Update Batch FundingAccount description: 'Create or Update multiple FundingAccount at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingAccount' text/json: schema: type: array items: $ref: '#/components/schemas/FundingAccount' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingAccount' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-account-categories: post: tags: - Funding Account Category summary: Create FundingAccountCategory description: Creates a new FundingAccountCategory operationId: CreateFundingAccountCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingAccountCategory' text/json: schema: $ref: '#/components/schemas/FundingAccountCategory' application/*+json: schema: $ref: '#/components/schemas/FundingAccountCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Account Category summary: List FundingAccountCategory description: Lists all FundingAccountCategory operationId: ListFundingAccountCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-account-categories/{accountCategory}': get: tags: - Funding Account Category summary: Get FundingAccountCategory description: Gets FundingAccountCategory operationId: GetFundingAccountCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountCategory in: path description: Account Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Account Category summary: Update FundingAccountCategory description: Updates a specific FundingAccountCategory. operationId: UpdateFundingAccountCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountCategory in: path description: Account Category required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingAccountCategory' text/json: schema: $ref: '#/components/schemas/FundingAccountCategory' application/*+json: schema: $ref: '#/components/schemas/FundingAccountCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Account Category summary: Delete FundingAccountCategory description: Deletes an FundingAccountCategory operationId: DeleteFundingAccountCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountCategory in: path description: Account Category required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-account-categories-batch: put: tags: - Funding Account Category summary: Create or Update Batch FundingAccountCategory description: 'Create or Update multiple FundingAccountCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingAccountCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingAccountCategory' text/json: schema: type: array items: $ref: '#/components/schemas/FundingAccountCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingAccountCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-accounts/{accountKey}/signatures': post: tags: - Funding Account Signatures summary: Create FundingAccountSignature description: Creates a new FundingAccountSignature operationId: CreateFundingAccountSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingAccountSignature' text/json: schema: $ref: '#/components/schemas/FundingAccountSignature' application/*+json: schema: $ref: '#/components/schemas/FundingAccountSignature' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountSignatureVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountSignatureVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountSignatureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Account Signatures summary: List FundingAccountSignature description: Lists all FundingAccountSignature for the given accountKey operationId: ListFundingAccountSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountSignatureListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountSignatureListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountSignatureListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-accounts/{accountKey}/signatures/{fundingAccountSignatureKey}': get: tags: - Funding Account Signatures summary: Get FundingAccountSignature description: Gets FundingAccountSignature operationId: GetFundingAccountSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 - name: fundingAccountSignatureKey in: path description: FundingAccountSignature Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountSignatureVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountSignatureVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountSignatureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Account Signatures summary: Update FundingAccountSignature description: Updates a specific FundingAccountSignature. operationId: UpdateFundingAccountSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 - name: fundingAccountSignatureKey in: path description: FundingAccountSignature Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingAccountSignature' text/json: schema: $ref: '#/components/schemas/FundingAccountSignature' application/*+json: schema: $ref: '#/components/schemas/FundingAccountSignature' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountSignatureVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountSignatureVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountSignatureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Account Signatures summary: Delete FundingAccountSignature description: Deletes an FundingAccountSignature operationId: DeleteFundingAccountSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 - name: fundingAccountSignatureKey in: path description: FundingAccountSignature Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-accounts/{accountKey}/signatures-batch': put: tags: - Funding Account Signatures summary: Create or Update Batch FundingAccountSignature description: 'Create or Update multiple FundingAccountSignature at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingAccountSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingAccountSignature' text/json: schema: type: array items: $ref: '#/components/schemas/FundingAccountSignature' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingAccountSignature' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-account-types: post: tags: - Funding Account Type summary: Create FundingAccountType description: Creates a new FundingAccountType operationId: CreateFundingAccountType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingAccountType' text/json: schema: $ref: '#/components/schemas/FundingAccountType' application/*+json: schema: $ref: '#/components/schemas/FundingAccountType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Account Type summary: List FundingAccountType description: Lists all FundingAccountType operationId: ListFundingAccountType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-account-types/{accountType}': get: tags: - Funding Account Type summary: Get FundingAccountType description: Gets FundingAccountType operationId: GetFundingAccountType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountType in: path description: Account Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Account Type summary: Update FundingAccountType description: Updates a specific FundingAccountType. operationId: UpdateFundingAccountType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountType in: path description: Account Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingAccountType' text/json: schema: $ref: '#/components/schemas/FundingAccountType' application/*+json: schema: $ref: '#/components/schemas/FundingAccountType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Account Type summary: Delete FundingAccountType description: Deletes an FundingAccountType operationId: DeleteFundingAccountType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: accountType in: path description: Account Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-account-types-batch: put: tags: - Funding Account Type summary: Create or Update Batch FundingAccountType description: 'Create or Update multiple FundingAccountType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingAccountType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingAccountType' text/json: schema: type: array items: $ref: '#/components/schemas/FundingAccountType' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingAccountType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-deposits: post: tags: - Funding Deposits summary: Create FundingDeposit description: Creates a new FundingDeposit operationId: CreateFundingDeposit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingDeposit' text/json: schema: $ref: '#/components/schemas/FundingDeposit' application/*+json: schema: $ref: '#/components/schemas/FundingDeposit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingDepositVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingDepositVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingDepositVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Deposits summary: List FundingDeposit description: Lists all FundingDeposit operationId: ListFundingDeposit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingDepositListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingDepositListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingDepositListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-deposits/{depositKey}/add-funding': post: tags: - Funding Deposits - Adv. Accounting summary: Add Funding to Deposit description: Creates Funding items and attaches them to an existing Deposit. operationId: AddFundingDeposit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: depositKey in: path description: Deposit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Funding' text/json: schema: type: array items: $ref: '#/components/schemas/Funding' application/*+json: schema: type: array items: $ref: '#/components/schemas/Funding' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingDepositVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingDepositVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingDepositVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/funding-deposits/{depositKey}': get: tags: - Funding Deposits summary: Get FundingDeposit description: Gets FundingDeposit operationId: GetFundingDeposit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: depositKey in: path description: Deposit Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingDepositVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingDepositVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingDepositVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Deposits summary: Update FundingDeposit description: Updates a specific FundingDeposit. operationId: UpdateFundingDeposit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: depositKey in: path description: Deposit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingDeposit' text/json: schema: $ref: '#/components/schemas/FundingDeposit' application/*+json: schema: $ref: '#/components/schemas/FundingDeposit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingDepositVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingDepositVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingDepositVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Deposits summary: Delete FundingDeposit description: Deletes an FundingDeposit operationId: DeleteFundingDeposit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: depositKey in: path description: Deposit Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-deposits/{depositKey}/void-deposit': delete: tags: - Funding Deposits summary: Void FundingDeposit description: Deletes an FundingDeposit entry and changes the associated Funding items back to unassigned (not part of any deposit). operationId: VoidFundingDeposit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: depositKey in: path description: Deposit Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-deposits-batch: put: tags: - Funding Deposits summary: Create or Update Batch FundingDeposit description: 'Create or Update multiple FundingDeposit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingDeposit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingDeposit' text/json: schema: type: array items: $ref: '#/components/schemas/FundingDeposit' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingDeposit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-indicators: post: tags: - Funding Indicators summary: Create FundingIndicator description: Creates a new FundingIndicator operationId: CreateFundingIndicator parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingIndicator' text/json: schema: $ref: '#/components/schemas/FundingIndicator' application/*+json: schema: $ref: '#/components/schemas/FundingIndicator' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingIndicatorVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingIndicatorVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingIndicatorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Indicators summary: List FundingIndicator description: Lists all FundingIndicator operationId: ListFundingIndicator parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingIndicatorListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingIndicatorListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingIndicatorListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-indicators/{fundingIndicator}': get: tags: - Funding Indicators summary: Get FundingIndicator description: Gets FundingIndicator operationId: GetFundingIndicator parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingIndicator in: path description: Funding Indicator required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingIndicatorVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingIndicatorVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingIndicatorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Indicators summary: Update FundingIndicator description: Updates a specific FundingIndicator. operationId: UpdateFundingIndicator parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingIndicator in: path description: Funding Indicator required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingIndicator' text/json: schema: $ref: '#/components/schemas/FundingIndicator' application/*+json: schema: $ref: '#/components/schemas/FundingIndicator' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingIndicatorVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingIndicatorVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingIndicatorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Indicators summary: Delete FundingIndicator description: Deletes an FundingIndicator operationId: DeleteFundingIndicator parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingIndicator in: path description: Funding Indicator required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-indicators-batch: put: tags: - Funding Indicators summary: Create or Update Batch FundingIndicator description: 'Create or Update multiple FundingIndicator at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingIndicator parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingIndicator' text/json: schema: type: array items: $ref: '#/components/schemas/FundingIndicator' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingIndicator' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-issue-types: post: tags: - Funding Issue Types summary: Create FundingIssueType description: Creates a new FundingIssueType operationId: CreateFundingIssueType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingIssueType' text/json: schema: $ref: '#/components/schemas/FundingIssueType' application/*+json: schema: $ref: '#/components/schemas/FundingIssueType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingIssueTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingIssueTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingIssueTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Issue Types summary: List FundingIssueType description: Lists all FundingIssueType operationId: ListFundingIssueType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingIssueTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingIssueTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingIssueTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-issue-types/{issueType}': get: tags: - Funding Issue Types summary: Get FundingIssueType description: Gets FundingIssueType operationId: GetFundingIssueType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: issueType in: path description: Issue Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingIssueTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingIssueTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingIssueTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Issue Types summary: Update FundingIssueType description: Updates a specific FundingIssueType. operationId: UpdateFundingIssueType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: issueType in: path description: Issue Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingIssueType' text/json: schema: $ref: '#/components/schemas/FundingIssueType' application/*+json: schema: $ref: '#/components/schemas/FundingIssueType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingIssueTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingIssueTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingIssueTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Issue Types summary: Delete FundingIssueType description: Deletes an FundingIssueType operationId: DeleteFundingIssueType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: issueType in: path description: Issue Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-issue-types-batch: put: tags: - Funding Issue Types summary: Create or Update Batch FundingIssueType description: 'Create or Update multiple FundingIssueType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingIssueType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingIssueType' text/json: schema: type: array items: $ref: '#/components/schemas/FundingIssueType' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingIssueType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-reconciliations: post: tags: - Funding Reconciliations summary: Create FundingReconcile description: Creates a new FundingReconcile operationId: CreateFundingReconcile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingReconcile' text/json: schema: $ref: '#/components/schemas/FundingReconcile' application/*+json: schema: $ref: '#/components/schemas/FundingReconcile' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Reconciliations summary: List FundingReconcile description: Lists all FundingReconcile operationId: ListFundingReconcile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-reconciliation-add: post: tags: - Funding Reconciliations - Adv. Accounting summary: Add Reconciliation description: Creates a new FundingReconcile along with attaching any Checks/Deposits identified. operationId: AddReconciliation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingStatement' text/json: schema: $ref: '#/components/schemas/FundingStatement' application/*+json: schema: $ref: '#/components/schemas/FundingStatement' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /funding-reconciliation-reconcile-funds: post: tags: - Funding Reconciliations - Adv. Accounting summary: Reconcile Funds description: 'Reconcile all Deposits, Checks, and Funding associated with this Reconciliation as well as creating offset debits and credits.' operationId: ReconcileFunds parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingStatement' text/json: schema: $ref: '#/components/schemas/FundingStatement' application/*+json: schema: $ref: '#/components/schemas/FundingStatement' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/funding-reconciliations/{reconcileKey}': get: tags: - Funding Reconciliations summary: Get FundingReconcile description: Gets FundingReconcile operationId: GetFundingReconcile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Reconciliations summary: Update FundingReconcile description: Updates a specific FundingReconcile. operationId: UpdateFundingReconcile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingReconcile' text/json: schema: $ref: '#/components/schemas/FundingReconcile' application/*+json: schema: $ref: '#/components/schemas/FundingReconcile' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Reconciliations summary: Delete FundingReconcile description: Deletes an FundingReconcile operationId: DeleteFundingReconcile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-reconciliations-batch: put: tags: - Funding Reconciliations summary: Create or Update Batch FundingReconcile description: 'Create or Update multiple FundingReconcile at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingReconcile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingReconcile' text/json: schema: type: array items: $ref: '#/components/schemas/FundingReconcile' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingReconcile' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-reconciliations/{reconcileKey}/disbursements': post: tags: - Funding Reconciliation Disbursements summary: Create FundingReconcileDisbursed description: Creates a new FundingReconcileDisbursed operationId: CreateFundingReconcileDisbursed parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingReconcileDisbursed' text/json: schema: $ref: '#/components/schemas/FundingReconcileDisbursed' application/*+json: schema: $ref: '#/components/schemas/FundingReconcileDisbursed' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileDisbursedVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileDisbursedVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileDisbursedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Reconciliation Disbursements summary: List FundingReconcileDisbursed description: Lists all FundingReconcileDisbursed for the given reconcileKey operationId: ListFundingReconcileDisbursed parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileDisbursedListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileDisbursedListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileDisbursedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-reconciliations/{reconcileKey}/disbursements/{checkID}': get: tags: - Funding Reconciliation Disbursements summary: Get FundingReconcileDisbursed description: Gets FundingReconcileDisbursed operationId: GetFundingReconcileDisbursed parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 - name: checkID in: path description: Check ID required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileDisbursedVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileDisbursedVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileDisbursedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Reconciliation Disbursements summary: Update FundingReconcileDisbursed description: Updates a specific FundingReconcileDisbursed. operationId: UpdateFundingReconcileDisbursed parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 - name: checkID in: path description: Check ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingReconcileDisbursed' text/json: schema: $ref: '#/components/schemas/FundingReconcileDisbursed' application/*+json: schema: $ref: '#/components/schemas/FundingReconcileDisbursed' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileDisbursedVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileDisbursedVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileDisbursedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Reconciliation Disbursements summary: Delete FundingReconcileDisbursed description: Deletes an FundingReconcileDisbursed operationId: DeleteFundingReconcileDisbursed parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 - name: checkID in: path description: Check ID required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-reconciliations/{reconcileKey}/disbursements-batch': put: tags: - Funding Reconciliation Disbursements summary: Create or Update Batch FundingReconcileDisbursed description: 'Create or Update multiple FundingReconcileDisbursed at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingReconcileDisbursed parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingReconcileDisbursed' text/json: schema: type: array items: $ref: '#/components/schemas/FundingReconcileDisbursed' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingReconcileDisbursed' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-reconciliations/{reconcileKey}/on-statements': post: tags: - Funding Reconciliation On Statements summary: Create FundingReconcileOnStatement description: Creates a new FundingReconcileOnStatement operationId: CreateFundingReconcileOnStatement parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingReconcileOnStatement' text/json: schema: $ref: '#/components/schemas/FundingReconcileOnStatement' application/*+json: schema: $ref: '#/components/schemas/FundingReconcileOnStatement' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileOnStatementVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileOnStatementVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileOnStatementVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Reconciliation On Statements summary: List FundingReconcileOnStatement description: Lists all FundingReconcileOnStatement for the given reconcileKey operationId: ListFundingReconcileOnStatement parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileOnStatementListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileOnStatementListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileOnStatementListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-reconciliations/{reconcileKey}/on-statements/{onStatementKey}': get: tags: - Funding Reconciliation On Statements summary: Get FundingReconcileOnStatement description: Gets FundingReconcileOnStatement operationId: GetFundingReconcileOnStatement parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 - name: onStatementKey in: path description: On Statement Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileOnStatementVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileOnStatementVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileOnStatementVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Reconciliation On Statements summary: Update FundingReconcileOnStatement description: Updates a specific FundingReconcileOnStatement. operationId: UpdateFundingReconcileOnStatement parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 - name: onStatementKey in: path description: On Statement Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingReconcileOnStatement' text/json: schema: $ref: '#/components/schemas/FundingReconcileOnStatement' application/*+json: schema: $ref: '#/components/schemas/FundingReconcileOnStatement' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileOnStatementVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileOnStatementVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileOnStatementVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Reconciliation On Statements summary: Delete FundingReconcileOnStatement description: Deletes an FundingReconcileOnStatement operationId: DeleteFundingReconcileOnStatement parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 - name: onStatementKey in: path description: On Statement Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-reconciliations/{reconcileKey}/on-statements-batch': put: tags: - Funding Reconciliation On Statements summary: Create or Update Batch FundingReconcileOnStatement description: 'Create or Update multiple FundingReconcileOnStatement at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingReconcileOnStatement parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingReconcileOnStatement' text/json: schema: type: array items: $ref: '#/components/schemas/FundingReconcileOnStatement' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingReconcileOnStatement' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-reconciliations/{reconcileKey}/deposits': post: tags: - Funding Reconciliations Received summary: Create FundingReconcileReceived description: Creates a new FundingReconcileReceived operationId: CreateFundingReconcileReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingReconcileReceived' text/json: schema: $ref: '#/components/schemas/FundingReconcileReceived' application/*+json: schema: $ref: '#/components/schemas/FundingReconcileReceived' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Reconciliations Received summary: List FundingReconcileReceived description: Lists all FundingReconcileReceived for the given reconcileKey operationId: ListFundingReconcileReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileReceivedListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileReceivedListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileReceivedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-reconciliations/{reconcileKey}/deposits/{depositKey}': get: tags: - Funding Reconciliations Received summary: Get FundingReconcileReceived description: Gets FundingReconcileReceived operationId: GetFundingReconcileReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 - name: depositKey in: path description: Deposit Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Reconciliations Received summary: Update FundingReconcileReceived description: Updates a specific FundingReconcileReceived. operationId: UpdateFundingReconcileReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 - name: depositKey in: path description: Deposit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingReconcileReceived' text/json: schema: $ref: '#/components/schemas/FundingReconcileReceived' application/*+json: schema: $ref: '#/components/schemas/FundingReconcileReceived' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Reconciliations Received summary: Delete FundingReconcileReceived description: Deletes an FundingReconcileReceived operationId: DeleteFundingReconcileReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 - name: depositKey in: path description: Deposit Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-reconciliations/{reconcileKey}/deposits-batch': put: tags: - Funding Reconciliations Received summary: Create or Update Batch FundingReconcileReceived description: 'Create or Update multiple FundingReconcileReceived at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingReconcileReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileKey in: path description: Reconcile Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingReconcileReceived' text/json: schema: type: array items: $ref: '#/components/schemas/FundingReconcileReceived' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingReconcileReceived' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-reconciliation-statuses: post: tags: - Funding Reconciliation Statuses summary: Create FundingReconcileStatus description: Creates a new FundingReconcileStatus operationId: CreateFundingReconcileStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingReconcileStatus' text/json: schema: $ref: '#/components/schemas/FundingReconcileStatus' application/*+json: schema: $ref: '#/components/schemas/FundingReconcileStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Reconciliation Statuses summary: List FundingReconcileStatus description: Lists all FundingReconcileStatus for the given reconcileStatus operationId: ListFundingReconcileStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-reconciliation-statuses/{reconcileStatus}': get: tags: - Funding Reconciliation Statuses summary: Get FundingReconcileStatus description: Gets FundingReconcileStatus operationId: GetFundingReconcileStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileStatus in: path description: Reconcile Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Reconciliation Statuses summary: Update FundingReconcileStatus description: Updates a specific FundingReconcileStatus. operationId: UpdateFundingReconcileStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileStatus in: path description: Reconcile Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingReconcileStatus' text/json: schema: $ref: '#/components/schemas/FundingReconcileStatus' application/*+json: schema: $ref: '#/components/schemas/FundingReconcileStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReconcileStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReconcileStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReconcileStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Reconciliation Statuses summary: Delete FundingReconcileStatus description: Deletes an FundingReconcileStatus operationId: DeleteFundingReconcileStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reconcileStatus in: path description: Reconcile Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-reconciliation-statuses-batch: put: tags: - Funding Reconciliation Statuses summary: Create or Update Batch FundingReconcileStatus description: 'Create or Update multiple FundingReconcileStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingReconcileStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingReconcileStatus' text/json: schema: type: array items: $ref: '#/components/schemas/FundingReconcileStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingReconcileStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-requests/{requestKey}/references': post: tags: - Funding References summary: Create FundingReference description: Creates a new FundingReference operationId: CreateFundingReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingReference' text/json: schema: $ref: '#/components/schemas/FundingReference' application/*+json: schema: $ref: '#/components/schemas/FundingReference' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReferenceVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReferenceVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReferenceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding References summary: List FundingReference description: Lists all FundingReference for the given requestKey operationId: ListFundingReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReferenceListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReferenceListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReferenceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-requests/{requestKey}/references/{fundingKey}': get: tags: - Funding References summary: Get FundingReference description: Gets FundingReference operationId: GetFundingReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 - name: fundingKey in: path description: Funding Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReferenceVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReferenceVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReferenceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding References summary: Update FundingReference description: Updates a specific FundingReference. operationId: UpdateFundingReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 - name: fundingKey in: path description: Funding Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingReference' text/json: schema: $ref: '#/components/schemas/FundingReference' application/*+json: schema: $ref: '#/components/schemas/FundingReference' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingReferenceVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingReferenceVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingReferenceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding References summary: Delete FundingReference description: Deletes an FundingReference operationId: DeleteFundingReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 - name: fundingKey in: path description: Funding Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-requests/{requestKey}/references-batch': put: tags: - Funding References summary: Create or Update Batch FundingReference description: 'Create or Update multiple FundingReference at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingReference' text/json: schema: type: array items: $ref: '#/components/schemas/FundingReference' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingReference' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-requests: post: tags: - Funding Requests summary: Create FundingRequest description: Creates a new FundingRequest operationId: CreateFundingRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingRequest' text/json: schema: $ref: '#/components/schemas/FundingRequest' application/*+json: schema: $ref: '#/components/schemas/FundingRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Requests summary: List FundingRequest description: Lists all FundingRequest operationId: ListFundingRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-requests/{requestKey}': get: tags: - Funding Requests summary: Get FundingRequest description: Gets FundingRequest operationId: GetFundingRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Requests summary: Update FundingRequest description: Updates a specific FundingRequest. operationId: UpdateFundingRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingRequest' text/json: schema: $ref: '#/components/schemas/FundingRequest' application/*+json: schema: $ref: '#/components/schemas/FundingRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Requests summary: Delete FundingRequest description: Deletes an FundingRequest operationId: DeleteFundingRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-requests-batch: put: tags: - Funding Requests summary: Create or Update Batch FundingRequest description: 'Create or Update multiple FundingRequest at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingRequest' text/json: schema: type: array items: $ref: '#/components/schemas/FundingRequest' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingRequest' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-requests/{requestKey}/satisfy': put: tags: - Funding Requests summary: Satisfy a Funding Request description: Satisfies a specific FundingRequest and handles partial request processing. operationId: SatisfyFundingRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingServiceSatisfyRequest' text/json: schema: $ref: '#/components/schemas/FundingServiceSatisfyRequest' application/*+json: schema: $ref: '#/components/schemas/FundingServiceSatisfyRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-requests/{requestKey}/claims': post: tags: - Funding Request Claims summary: Create FundingRequestClaim description: Creates a new FundingRequestClaim operationId: CreateFundingRequestClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingRequestClaim' text/json: schema: $ref: '#/components/schemas/FundingRequestClaim' application/*+json: schema: $ref: '#/components/schemas/FundingRequestClaim' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Request Claims summary: List FundingRequestClaim description: Lists all FundingRequestClaim for the given requestKey operationId: ListFundingRequestClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestClaimListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestClaimListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestClaimListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-requests/{requestKey}/claims-summary': get: tags: - Funding Request Claims summary: List FundingRequestClaim Summary description: Lists all FundingRequestClaim Summary for the given requestKey. The Summary view has additional computed fields that are ot present on the FundingRequestClaim object. operationId: ListFundingRequestClaimSummary parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_FundingRequestClaimSummaryListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_FundingRequestClaimSummaryListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_FundingRequestClaimSummaryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-requests/{requestKey}/claims/{batchNumber}/{batchClaim}': get: tags: - Funding Request Claims summary: Get FundingRequestClaim description: Gets FundingRequestClaim operationId: GetFundingRequestClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Request Claims summary: Update FundingRequestClaim description: Updates a specific FundingRequestClaim. operationId: UpdateFundingRequestClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingRequestClaim' text/json: schema: $ref: '#/components/schemas/FundingRequestClaim' application/*+json: schema: $ref: '#/components/schemas/FundingRequestClaim' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Request Claims summary: Delete FundingRequestClaim description: Deletes an FundingRequestClaim operationId: DeleteFundingRequestClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 - name: batchNumber in: path description: Batch Number required: true schema: type: integer format: int32 - name: batchClaim in: path description: Batch Claim required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-requests/{requestKey}/claims-batch': put: tags: - Funding Request Claims summary: Create or Update Batch FundingRequestClaim description: 'Create or Update multiple FundingRequestClaim at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingRequestClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestKey in: path description: Request Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingRequestClaim' text/json: schema: type: array items: $ref: '#/components/schemas/FundingRequestClaim' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingRequestClaim' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-request-statuses: post: tags: - Funding Request Statuses summary: Create FundingRequestStatus description: Creates a new FundingRequestStatus operationId: CreateFundingRequestStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingRequestStatus' text/json: schema: $ref: '#/components/schemas/FundingRequestStatus' application/*+json: schema: $ref: '#/components/schemas/FundingRequestStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Request Statuses summary: List FundingRequestStatus description: Lists all FundingRequestStatus operationId: ListFundingRequestStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-request-statuses/{requestStatus}': get: tags: - Funding Request Statuses summary: Get FundingRequestStatus description: Gets FundingRequestStatus operationId: GetFundingRequestStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestStatus in: path description: Request Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Request Statuses summary: Update FundingRequestStatus description: Updates a specific FundingRequestStatus. operationId: UpdateFundingRequestStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestStatus in: path description: Request Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingRequestStatus' text/json: schema: $ref: '#/components/schemas/FundingRequestStatus' application/*+json: schema: $ref: '#/components/schemas/FundingRequestStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Request Statuses summary: Delete FundingRequestStatus description: Deletes an FundingRequestStatus operationId: DeleteFundingRequestStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestStatus in: path description: Request Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-request-statuses-batch: put: tags: - Funding Request Statuses summary: Create or Update Batch FundingRequestStatus description: 'Create or Update multiple FundingRequestStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingRequestStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingRequestStatus' text/json: schema: type: array items: $ref: '#/components/schemas/FundingRequestStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingRequestStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-request-types: post: tags: - Funding Request Types summary: Create FundingRequestType description: Creates a new FundingRequestType operationId: CreateFundingRequestType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingRequestType' text/json: schema: $ref: '#/components/schemas/FundingRequestType' application/*+json: schema: $ref: '#/components/schemas/FundingRequestType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Request Types summary: List FundingRequestType description: Lists all FundingRequestType operationId: ListFundingRequestType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-request-types/{requestType}': get: tags: - Funding Request Types summary: Get FundingRequestType description: Gets FundingRequestType operationId: GetFundingRequestType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestType in: path description: Request Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Request Types summary: Update FundingRequestType description: Updates a specific FundingRequestType. operationId: UpdateFundingRequestType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestType in: path description: Request Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingRequestType' text/json: schema: $ref: '#/components/schemas/FundingRequestType' application/*+json: schema: $ref: '#/components/schemas/FundingRequestType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingRequestTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingRequestTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingRequestTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Request Types summary: Delete FundingRequestType description: Deletes an FundingRequestType operationId: DeleteFundingRequestType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestType in: path description: Request Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-request-types-batch: put: tags: - Funding Request Types summary: Create or Update Batch FundingRequestType description: 'Create or Update multiple FundingRequestType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingRequestType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingRequestType' text/json: schema: type: array items: $ref: '#/components/schemas/FundingRequestType' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingRequestType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-statement-formats: post: tags: - Funding Statement Formats summary: Create FundingStatementFormat description: Creates a new FundingStatementFormat operationId: CreateFundingStatementFormat parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingStatementFormat' text/json: schema: $ref: '#/components/schemas/FundingStatementFormat' application/*+json: schema: $ref: '#/components/schemas/FundingStatementFormat' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingStatementFormatVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingStatementFormatVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingStatementFormatVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Statement Formats summary: List FundingStatementFormat description: Lists all FundingStatementFormat operationId: ListFundingStatementFormat parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingStatementFormatListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingStatementFormatListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingStatementFormatListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-statement-formats/{statementFormatKey}': get: tags: - Funding Statement Formats summary: Get FundingStatementFormat description: Gets FundingStatementFormat operationId: GetFundingStatementFormat parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: statementFormatKey in: path description: Statement Format Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingStatementFormatVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingStatementFormatVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingStatementFormatVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Statement Formats summary: Update FundingStatementFormat description: Updates a specific FundingStatementFormat. operationId: UpdateFundingStatementFormat parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: statementFormatKey in: path description: Statement Format Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingStatementFormat' text/json: schema: $ref: '#/components/schemas/FundingStatementFormat' application/*+json: schema: $ref: '#/components/schemas/FundingStatementFormat' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingStatementFormatVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingStatementFormatVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingStatementFormatVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Statement Formats summary: Delete FundingStatementFormat description: Deletes an FundingStatementFormat operationId: DeleteFundingStatementFormat parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: statementFormatKey in: path description: Statement Format Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-statement-formats-batch: put: tags: - Funding Statement Formats summary: Create or Update Batch FundingStatementFormat description: 'Create or Update multiple FundingStatementFormat at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingStatementFormat parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingStatementFormat' text/json: schema: type: array items: $ref: '#/components/schemas/FundingStatementFormat' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingStatementFormat' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-statuses: post: tags: - Funding Statuses summary: Create FundingStatus description: Creates a new FundingStatus operationId: CreateFundingStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingStatus' text/json: schema: $ref: '#/components/schemas/FundingStatus' application/*+json: schema: $ref: '#/components/schemas/FundingStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Statuses summary: List FundingStatus description: Lists all FundingStatus operationId: ListFundingStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-statuses/{fundingStatus}': get: tags: - Funding Statuses summary: Get FundingStatus description: Gets FundingStatus operationId: GetFundingStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingStatus in: path description: Funding Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Statuses summary: Update FundingStatus description: Updates a specific FundingStatus. operationId: UpdateFundingStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingStatus in: path description: Funding Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingStatus' text/json: schema: $ref: '#/components/schemas/FundingStatus' application/*+json: schema: $ref: '#/components/schemas/FundingStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Statuses summary: Delete FundingStatus description: Deletes an FundingStatus operationId: DeleteFundingStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingStatus in: path description: Funding Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-statuses-batch: put: tags: - Funding Statuses summary: Create or Update Batch FundingStatus description: 'Create or Update multiple FundingStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingStatus' text/json: schema: type: array items: $ref: '#/components/schemas/FundingStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-types: post: tags: - Funding Types summary: Create FundingType description: Creates a new FundingType operationId: CreateFundingType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingType' text/json: schema: $ref: '#/components/schemas/FundingType' application/*+json: schema: $ref: '#/components/schemas/FundingType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Funding Types summary: List FundingType description: Lists all FundingType operationId: ListFundingType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/funding-types/{fundingType}': get: tags: - Funding Types summary: Get FundingType description: Gets FundingType operationId: GetFundingType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingType in: path description: Funding Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Funding Types summary: Update FundingType description: Updates a specific FundingType. operationId: UpdateFundingType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingType in: path description: Funding Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundingType' text/json: schema: $ref: '#/components/schemas/FundingType' application/*+json: schema: $ref: '#/components/schemas/FundingType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Funding Types summary: Delete FundingType description: Deletes an FundingType operationId: DeleteFundingType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fundingType in: path description: Funding Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /funding-types-batch: put: tags: - Funding Types summary: Create or Update Batch FundingType description: 'Create or Update multiple FundingType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchFundingType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FundingType' text/json: schema: type: array items: $ref: '#/components/schemas/FundingType' application/*+json: schema: type: array items: $ref: '#/components/schemas/FundingType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /genders: post: tags: - Gender summary: Create Gender description: Creates a new Gender operationId: CreateGender parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Gender' text/json: schema: $ref: '#/components/schemas/Gender' application/*+json: schema: $ref: '#/components/schemas/Gender' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GenderVBAResponse' application/json: schema: $ref: '#/components/schemas/GenderVBAResponse' text/json: schema: $ref: '#/components/schemas/GenderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Gender summary: List Gender description: Lists all Gender operationId: ListGender parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GenderListVBAResponse' application/json: schema: $ref: '#/components/schemas/GenderListVBAResponse' text/json: schema: $ref: '#/components/schemas/GenderListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/genders/{Gender_Code}': get: tags: - Gender summary: Get Gender description: Gets Gender operationId: GetGender parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Gender_Code in: path description: Gender Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GenderVBAResponse' application/json: schema: $ref: '#/components/schemas/GenderVBAResponse' text/json: schema: $ref: '#/components/schemas/GenderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Gender summary: Update Gender description: Updates a specific Gender. operationId: UpdateGender parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Gender_Code in: path description: Gender Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Gender' text/json: schema: $ref: '#/components/schemas/Gender' application/*+json: schema: $ref: '#/components/schemas/Gender' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GenderVBAResponse' application/json: schema: $ref: '#/components/schemas/GenderVBAResponse' text/json: schema: $ref: '#/components/schemas/GenderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Gender summary: Delete Gender description: Deletes an Gender operationId: DeleteGender parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Gender_Code in: path description: Gender Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /genders-batch: put: tags: - Gender summary: Create or Update Batch Gender description: 'Create or Update multiple Gender at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGender parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Gender' text/json: schema: type: array items: $ref: '#/components/schemas/Gender' application/*+json: schema: type: array items: $ref: '#/components/schemas/Gender' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievances: post: tags: - Grievances summary: Create Grievance description: Creates a new Grievance operationId: CreateGrievance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Grievance' text/json: schema: $ref: '#/components/schemas/Grievance' application/*+json: schema: $ref: '#/components/schemas/Grievance' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Grievances summary: List Grievance description: Lists all Grievance operationId: ListGrievance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceListVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceListVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/grievances/{grievanceKey}': get: tags: - Grievances summary: Get Grievance description: Gets Grievance operationId: GetGrievance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceKey in: path description: Grievance Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Grievances summary: Update Grievance description: Updates a specific Grievance. operationId: UpdateGrievance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceKey in: path description: Grievance Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Grievance' text/json: schema: $ref: '#/components/schemas/Grievance' application/*+json: schema: $ref: '#/components/schemas/Grievance' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Grievances summary: Delete Grievance description: Deletes an Grievance operationId: DeleteGrievance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceKey in: path description: Grievance Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievances-batch: delete: tags: - Grievances summary: Batch Delete Grievance description: Delete a list of Grievances. operationId: DeleteBatchGrievance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Grievance' text/json: schema: type: array items: $ref: '#/components/schemas/Grievance' application/*+json: schema: type: array items: $ref: '#/components/schemas/Grievance' required: true responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Grievances summary: Create or Update Batch Grievance description: 'Create or Update multiple Grievance at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGrievance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Grievance' text/json: schema: type: array items: $ref: '#/components/schemas/Grievance' application/*+json: schema: type: array items: $ref: '#/components/schemas/Grievance' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievances-file: post: tags: - Grievances - Adv. Grievance summary: File Grievance description: Files a Grievance for a Member or Subscriber and gives back the created grievance for further processing. operationId: FileGrievance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GrievanceFiling' text/json: schema: $ref: '#/components/schemas/GrievanceFiling' application/*+json: schema: $ref: '#/components/schemas/GrievanceFiling' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /grievance-admin-change-types: post: tags: - Grievance Admin Change Types summary: Create GrievanceAdminChangeType description: Creates a new GrievanceAdminChangeType operationId: CreateGrievanceAdminChangeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GrievanceAdminChangeType' text/json: schema: $ref: '#/components/schemas/GrievanceAdminChangeType' application/*+json: schema: $ref: '#/components/schemas/GrievanceAdminChangeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceAdminChangeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceAdminChangeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceAdminChangeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Grievance Admin Change Types summary: List GrievanceAdminChangeType description: Lists all GrievanceAdminChangeType operationId: ListGrievanceAdminChangeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceAdminChangeTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceAdminChangeTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceAdminChangeTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/grievance-admin-change-types/{grievanceAdminChangeType}': get: tags: - Grievance Admin Change Types summary: Get GrievanceAdminChangeType description: Gets GrievanceAdminChangeType operationId: GetGrievanceAdminChangeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceAdminChangeType in: path description: Grievance Admin Change Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceAdminChangeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceAdminChangeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceAdminChangeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Grievance Admin Change Types summary: Update GrievanceAdminChangeType description: Updates a specific GrievanceAdminChangeType. operationId: UpdateGrievanceAdminChangeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceAdminChangeType in: path description: Grievance Admin Change Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GrievanceAdminChangeType' text/json: schema: $ref: '#/components/schemas/GrievanceAdminChangeType' application/*+json: schema: $ref: '#/components/schemas/GrievanceAdminChangeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceAdminChangeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceAdminChangeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceAdminChangeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Grievance Admin Change Types summary: Delete GrievanceAdminChangeType description: Deletes an GrievanceAdminChangeType operationId: DeleteGrievanceAdminChangeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceAdminChangeType in: path description: Grievance Admin Change Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievance-admin-change-types-batch: put: tags: - Grievance Admin Change Types summary: Create or Update Batch GrievanceAdminChangeType description: 'Create or Update multiple GrievanceAdminChangeType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGrievanceAdminChangeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GrievanceAdminChangeType' text/json: schema: type: array items: $ref: '#/components/schemas/GrievanceAdminChangeType' application/*+json: schema: type: array items: $ref: '#/components/schemas/GrievanceAdminChangeType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievance-categories: post: tags: - Grievance Categories summary: Create GrievanceCategory description: Creates a new GrievanceCategory operationId: CreateGrievanceCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GrievanceCategory' text/json: schema: $ref: '#/components/schemas/GrievanceCategory' application/*+json: schema: $ref: '#/components/schemas/GrievanceCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Grievance Categories summary: List GrievanceCategory description: Lists all GrievanceCategory operationId: ListGrievanceCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/grievance-categories/{grievanceCategory}': get: tags: - Grievance Categories summary: Get GrievanceCategory description: Gets GrievanceCategory operationId: GetGrievanceCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceCategory in: path description: Grievance Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Grievance Categories summary: Update GrievanceCategory description: Updates a specific GrievanceCategory. operationId: UpdateGrievanceCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceCategory in: path description: Grievance Category required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GrievanceCategory' text/json: schema: $ref: '#/components/schemas/GrievanceCategory' application/*+json: schema: $ref: '#/components/schemas/GrievanceCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Grievance Categories summary: Delete GrievanceCategory description: Deletes an GrievanceCategory operationId: DeleteGrievanceCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceCategory in: path description: Grievance Category required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievance-categories-batch: put: tags: - Grievance Categories summary: Create or Update Batch GrievanceCategory description: 'Create or Update multiple GrievanceCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGrievanceCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GrievanceCategory' text/json: schema: type: array items: $ref: '#/components/schemas/GrievanceCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/GrievanceCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievance-issue-types: post: tags: - Grievance Issue Types summary: Create GrievanceIssueType description: Creates a new GrievanceIssueType operationId: CreateGrievanceIssueType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GrievanceIssueType' text/json: schema: $ref: '#/components/schemas/GrievanceIssueType' application/*+json: schema: $ref: '#/components/schemas/GrievanceIssueType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceIssueTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceIssueTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceIssueTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Grievance Issue Types summary: List GrievanceIssueType description: Lists all GrievanceIssueType operationId: ListGrievanceIssueType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceIssueTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceIssueTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceIssueTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/grievance-issue-types/{grievanceIssueType}': get: tags: - Grievance Issue Types summary: Get GrievanceIssueType description: Gets GrievanceIssueType operationId: GetGrievanceIssueType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceIssueType in: path description: Grievance Issue Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceIssueTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceIssueTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceIssueTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Grievance Issue Types summary: Update GrievanceIssueType description: Updates a specific GrievanceIssueType. operationId: UpdateGrievanceIssueType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceIssueType in: path description: Grievance Issue Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GrievanceIssueType' text/json: schema: $ref: '#/components/schemas/GrievanceIssueType' application/*+json: schema: $ref: '#/components/schemas/GrievanceIssueType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceIssueTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceIssueTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceIssueTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Grievance Issue Types summary: Delete GrievanceIssueType description: Deletes an GrievanceIssueType operationId: DeleteGrievanceIssueType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceIssueType in: path description: Grievance Issue Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievance-issue-types-batch: put: tags: - Grievance Issue Types summary: Create or Update Batch GrievanceIssueType description: 'Create or Update multiple GrievanceIssueType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGrievanceIssueType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GrievanceIssueType' text/json: schema: type: array items: $ref: '#/components/schemas/GrievanceIssueType' application/*+json: schema: type: array items: $ref: '#/components/schemas/GrievanceIssueType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievance-resolution-types: post: tags: - Grievance Resolution Types summary: Create GrievanceResolutionType description: Creates a new GrievanceResolutionType operationId: CreateGrievanceResolutionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GrievanceResolutionType' text/json: schema: $ref: '#/components/schemas/GrievanceResolutionType' application/*+json: schema: $ref: '#/components/schemas/GrievanceResolutionType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceResolutionTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceResolutionTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceResolutionTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Grievance Resolution Types summary: List GrievanceResolutionType description: Lists all GrievanceResolutionType operationId: ListGrievanceResolutionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceResolutionTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceResolutionTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceResolutionTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/grievance-resolution-types/{grievanceResolutionType}': get: tags: - Grievance Resolution Types summary: Get GrievanceResolutionType description: Gets GrievanceResolutionType operationId: GetGrievanceResolutionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceResolutionType in: path description: Grievance Resolution Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceResolutionTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceResolutionTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceResolutionTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Grievance Resolution Types summary: Update GrievanceResolutionType description: Updates a specific GrievanceResolutionType. operationId: UpdateGrievanceResolutionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceResolutionType in: path description: Grievance Resolution Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GrievanceResolutionType' text/json: schema: $ref: '#/components/schemas/GrievanceResolutionType' application/*+json: schema: $ref: '#/components/schemas/GrievanceResolutionType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceResolutionTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceResolutionTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceResolutionTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Grievance Resolution Types summary: Delete GrievanceResolutionType description: Deletes an GrievanceResolutionType operationId: DeleteGrievanceResolutionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceResolutionType in: path description: Grievance Resolution Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievance-resolution-types-batch: put: tags: - Grievance Resolution Types summary: Create or Update Batch GrievanceResolutionType description: 'Create or Update multiple GrievanceResolutionType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGrievanceResolutionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GrievanceResolutionType' text/json: schema: type: array items: $ref: '#/components/schemas/GrievanceResolutionType' application/*+json: schema: type: array items: $ref: '#/components/schemas/GrievanceResolutionType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievance-statuses: post: tags: - Grievance Statuses summary: Create GrievanceStatus description: Creates a new GrievanceStatus operationId: CreateGrievanceStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GrievanceStatus' text/json: schema: $ref: '#/components/schemas/GrievanceStatus' application/*+json: schema: $ref: '#/components/schemas/GrievanceStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Grievance Statuses summary: List GrievanceStatus description: Lists all GrievanceStatus operationId: ListGrievanceStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/grievance-statuses/{grievanceStatus}': get: tags: - Grievance Statuses summary: Get GrievanceStatus description: Gets GrievanceStatus operationId: GetGrievanceStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceStatus in: path description: Grievance Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Grievance Statuses summary: Update GrievanceStatus description: Updates a specific GrievanceStatus. operationId: UpdateGrievanceStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceStatus in: path description: Grievance Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GrievanceStatus' text/json: schema: $ref: '#/components/schemas/GrievanceStatus' application/*+json: schema: $ref: '#/components/schemas/GrievanceStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Grievance Statuses summary: Delete GrievanceStatus description: Deletes an GrievanceStatus operationId: DeleteGrievanceStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceStatus in: path description: Grievance Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievance-statuses-batch: put: tags: - Grievance Statuses summary: Create or Update Batch GrievanceStatus description: 'Create or Update multiple GrievanceStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGrievanceStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GrievanceStatus' text/json: schema: type: array items: $ref: '#/components/schemas/GrievanceStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/GrievanceStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievance-types: post: tags: - Grievance Types summary: Create GrievanceType description: Creates a new GrievanceType operationId: CreateGrievanceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GrievanceType' text/json: schema: $ref: '#/components/schemas/GrievanceType' application/*+json: schema: $ref: '#/components/schemas/GrievanceType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Grievance Types summary: List GrievanceType description: Lists all GrievanceType operationId: ListGrievanceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/grievance-types/{grievanceType}': get: tags: - Grievance Types summary: Get GrievanceType description: Gets GrievanceType operationId: GetGrievanceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceType in: path description: Grievance Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Grievance Types summary: Update GrievanceType description: Updates a specific GrievanceType. operationId: UpdateGrievanceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceType in: path description: Grievance Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GrievanceType' text/json: schema: $ref: '#/components/schemas/GrievanceType' application/*+json: schema: $ref: '#/components/schemas/GrievanceType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GrievanceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GrievanceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GrievanceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Grievance Types summary: Delete GrievanceType description: Deletes an GrievanceType operationId: DeleteGrievanceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: grievanceType in: path description: Grievance Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /grievance-types-batch: put: tags: - Grievance Types summary: Create or Update Batch GrievanceType description: 'Create or Update multiple GrievanceType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGrievanceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GrievanceType' text/json: schema: type: array items: $ref: '#/components/schemas/GrievanceType' application/*+json: schema: type: array items: $ref: '#/components/schemas/GrievanceType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/account-periods': post: tags: - Group Account Periods summary: Create GroupAccountPeriod description: Creates a new GroupAccountPeriod operationId: CreateGroupAccountPeriod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupAccountPeriod' text/json: schema: $ref: '#/components/schemas/GroupAccountPeriod' application/*+json: schema: $ref: '#/components/schemas/GroupAccountPeriod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupAccountPeriodVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupAccountPeriodVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupAccountPeriodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Account Periods summary: List GroupAccountPeriod description: Lists all GroupAccountPeriod operationId: ListGroupAccountPeriod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupAccountPeriodListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupAccountPeriodListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupAccountPeriodListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/account-periods/{groupAccountPeriodKey}': get: tags: - Group Account Periods summary: Get GroupAccountPeriod description: Gets GroupAccountPeriod operationId: GetGroupAccountPeriod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupAccountPeriodKey in: path description: GroupAccountPeriod Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupAccountPeriodVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupAccountPeriodVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupAccountPeriodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Account Periods summary: Update GroupAccountPeriod description: Updates a specific GroupAccountPeriod. operationId: UpdateGroupAccountPeriod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupAccountPeriodKey in: path description: GroupAccountPeriod Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupAccountPeriod' text/json: schema: $ref: '#/components/schemas/GroupAccountPeriod' application/*+json: schema: $ref: '#/components/schemas/GroupAccountPeriod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupAccountPeriodVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupAccountPeriodVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupAccountPeriodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Account Periods summary: Delete GroupAccountPeriod description: Deletes an GroupAccountPeriod operationId: DeleteGroupAccountPeriod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupAccountPeriodKey in: path description: GroupAccountPeriod Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/account-periods-batch': put: tags: - Group Account Periods summary: Create or Update Batch GroupAccountPeriod description: 'Create or Update multiple GroupAccountPeriod at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupAccountPeriod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupAccountPeriod' text/json: schema: type: array items: $ref: '#/components/schemas/GroupAccountPeriod' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupAccountPeriod' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/account-reports': post: tags: - Group Account Reports summary: Create GroupAccountReport description: Creates a new GroupAccountReport operationId: CreateGroupAccountReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupAccountReport' text/json: schema: $ref: '#/components/schemas/GroupAccountReport' application/*+json: schema: $ref: '#/components/schemas/GroupAccountReport' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupAccountReportVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupAccountReportVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupAccountReportVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Account Reports summary: List GroupAccountReport description: Lists all GroupAccountReport for the given groupID operationId: ListGroupAccountReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupAccountReportListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupAccountReportListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupAccountReportListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/account-reports/{accountKey}': get: tags: - Group Account Reports summary: Get GroupAccountReport description: Gets GroupAccountReport operationId: GetGroupAccountReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupAccountReportVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupAccountReportVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupAccountReportVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Account Reports summary: Update GroupAccountReport description: Updates a specific GroupAccountReport. operationId: UpdateGroupAccountReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupAccountReport' text/json: schema: $ref: '#/components/schemas/GroupAccountReport' application/*+json: schema: $ref: '#/components/schemas/GroupAccountReport' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupAccountReportVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupAccountReportVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupAccountReportVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Account Reports summary: Delete GroupAccountReport description: Deletes an GroupAccountReport operationId: DeleteGroupAccountReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/account-reports-batch': put: tags: - Group Account Reports summary: Create or Update Batch GroupAccountReport description: 'Create or Update multiple GroupAccountReport at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupAccountReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupAccountReport' text/json: schema: type: array items: $ref: '#/components/schemas/GroupAccountReport' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupAccountReport' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{Group_ID}/ach-pulls': post: tags: - Group ACH Pulls summary: Create GroupACHPull description: Creates a new GroupACHPull operationId: CreateGroupACHPull parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Group_ID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupACHPull' text/json: schema: $ref: '#/components/schemas/GroupACHPull' application/*+json: schema: $ref: '#/components/schemas/GroupACHPull' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupACHPullVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupACHPullVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupACHPullVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group ACH Pulls summary: List GroupACHPull description: Lists all GroupACHPull for the given Group_ID operationId: ListGroupACHPull parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Group_ID in: path description: Group ID required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupACHPullListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupACHPullListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupACHPullListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{Group_ID}/ach-pulls/{ACH_Pull_Day}': get: tags: - Group ACH Pulls summary: Get GroupACHPull description: Gets GroupACHPull operationId: GetGroupACHPull parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Group_ID in: path description: Group ID required: true schema: type: string - name: ACH_Pull_Day in: path description: ACH Pull Day required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupACHPullVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupACHPullVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupACHPullVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group ACH Pulls summary: Update GroupACHPull description: Updates a specific GroupACHPull. operationId: UpdateGroupACHPull parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Group_ID in: path description: Group ID required: true schema: type: string - name: ACH_Pull_Day in: path description: ACH Pull Day required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupACHPull' text/json: schema: $ref: '#/components/schemas/GroupACHPull' application/*+json: schema: $ref: '#/components/schemas/GroupACHPull' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupACHPullVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupACHPullVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupACHPullVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group ACH Pulls summary: Delete GroupACHPull description: Deletes an GroupACHPull operationId: DeleteGroupACHPull parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Group_ID in: path description: Group ID required: true schema: type: string - name: ACH_Pull_Day in: path description: ACH Pull Day required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{Group_ID}/ach-pulls-batch': put: tags: - Group ACH Pulls summary: Create or Update Batch GroupACHPull description: 'Create or Update multiple GroupACHPull at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupACHPull parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Group_ID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupACHPull' text/json: schema: type: array items: $ref: '#/components/schemas/GroupACHPull' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupACHPull' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/avdvice-to-pay': post: tags: - Group Advice to Pay summary: Create GroupATP description: Creates a new GroupATP operationId: CreateGroupATP parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupATP' text/json: schema: $ref: '#/components/schemas/GroupATP' application/*+json: schema: $ref: '#/components/schemas/GroupATP' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupATPVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupATPVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupATPVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Advice to Pay summary: List GroupATP description: Lists all GroupATP for the given groupID operationId: ListGroupATP parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupATPListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupATPListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupATPListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/avdvice-to-pay/{groupATPKey}': get: tags: - Group Advice to Pay summary: Get GroupATP description: Gets GroupATP operationId: GetGroupATP parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupATPKey in: path description: GroupATP Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupATPVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupATPVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupATPVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Advice to Pay summary: Update GroupATP description: Updates a specific GroupATP. operationId: UpdateGroupATP parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupATPKey in: path description: GroupATP Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupATP' text/json: schema: $ref: '#/components/schemas/GroupATP' application/*+json: schema: $ref: '#/components/schemas/GroupATP' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupATPVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupATPVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupATPVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Advice to Pay summary: Delete GroupATP description: Deletes an GroupATP operationId: DeleteGroupATP parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupATPKey in: path description: GroupATP Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/avdvice-to-pay-batch': put: tags: - Group Advice to Pay summary: Create or Update Batch GroupATP description: 'Create or Update multiple GroupATP at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupATP parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupATP' text/json: schema: type: array items: $ref: '#/components/schemas/GroupATP' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupATP' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-bill-cycle-payment-methods: post: tags: - Group Bill Cycle Payment Methods summary: Create GroupBillCyclePaymentMethod description: Creates a new GroupBillCyclePaymentMethod operationId: CreateGroupBillCyclePaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethod' text/json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethod' application/*+json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Bill Cycle Payment Methods summary: List GroupBillCyclePaymentMethod description: Lists all GroupBillCyclePaymentMethod operationId: ListGroupBillCyclePaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethodListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethodListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethodListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/group-bill-cycle-payment-methods/{GroupBillCyclePaymentMethod_Key}': get: tags: - Group Bill Cycle Payment Methods summary: Get GroupBillCyclePaymentMethod description: Gets GroupBillCyclePaymentMethod operationId: GetGroupBillCyclePaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: GroupBillCyclePaymentMethod_Key in: path description: GroupBillCyclePaymentMethod Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Bill Cycle Payment Methods summary: Update GroupBillCyclePaymentMethod description: Updates a specific GroupBillCyclePaymentMethod. operationId: UpdateGroupBillCyclePaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: GroupBillCyclePaymentMethod_Key in: path description: GroupBillCyclePaymentMethod Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethod' text/json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethod' application/*+json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupBillCyclePaymentMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Bill Cycle Payment Methods summary: Delete GroupBillCyclePaymentMethod description: Deletes an GroupBillCyclePaymentMethod operationId: DeleteGroupBillCyclePaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: GroupBillCyclePaymentMethod_Key in: path description: GroupBillCyclePaymentMethod Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-bill-cycle-payment-methods-batch: put: tags: - Group Bill Cycle Payment Methods summary: Create or Update Batch GroupBillCyclePaymentMethod description: 'Create or Update multiple GroupBillCyclePaymentMethod at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupBillCyclePaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupBillCyclePaymentMethod' text/json: schema: type: array items: $ref: '#/components/schemas/GroupBillCyclePaymentMethod' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupBillCyclePaymentMethod' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/classes': post: tags: - Group Classes summary: Create GroupClass description: Creates a new GroupClass operationId: CreateGroupClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupClass' text/json: schema: $ref: '#/components/schemas/GroupClass' application/*+json: schema: $ref: '#/components/schemas/GroupClass' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupClassVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupClassVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupClassVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Classes summary: List GroupClass description: Lists all GroupClass for the given groupID operationId: ListGroupClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupClassListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupClassListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupClassListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/classes/{groupDivisionClassKey}': get: tags: - Group Classes summary: Get GroupClass description: Gets GroupClass operationId: GetGroupClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupDivisionClassKey in: path description: GroupDivisionClass Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupClassVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupClassVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupClassVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Classes summary: Update GroupClass description: Updates a specific GroupClass. operationId: UpdateGroupClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupDivisionClassKey in: path description: GroupDivisionClass Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupClass' text/json: schema: $ref: '#/components/schemas/GroupClass' application/*+json: schema: $ref: '#/components/schemas/GroupClass' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupClassVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupClassVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupClassVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Classes summary: Delete GroupClass description: Deletes an GroupClass operationId: DeleteGroupClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupDivisionClassKey in: path description: GroupDivisionClass Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/classes-batch': put: tags: - Group Classes summary: Create or Update Batch GroupClass description: 'Create or Update multiple GroupClass at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupClass' text/json: schema: type: array items: $ref: '#/components/schemas/GroupClass' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupClass' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/company-data-ex-code-overrides': post: tags: - Group Company Data Ex-Code Overrides summary: Create GroupCompanyDataExCodeOverride description: Creates a new GroupCompanyDataExCodeOverride operationId: CreateGroupCompanyDataExCodeOverride parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverride' text/json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverride' application/*+json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverride' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverrideVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverrideVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverrideVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Company Data Ex-Code Overrides summary: List GroupCompanyDataExCodeOverride description: Lists all GroupCompanyDataExCodeOverride for the given groupID operationId: ListGroupCompanyDataExCodeOverride parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverrideListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverrideListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverrideListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/company-data-ex-code-overrides/{groupCompanyDataExCodeOverrideKey}': get: tags: - Group Company Data Ex-Code Overrides summary: Get GroupCompanyDataExCodeOverride description: Gets GroupCompanyDataExCodeOverride operationId: GetGroupCompanyDataExCodeOverride parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupCompanyDataExCodeOverrideKey in: path description: GroupCompanyDataExCodeOverride Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverrideVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverrideVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverrideVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Company Data Ex-Code Overrides summary: Update GroupCompanyDataExCodeOverride description: Updates a specific GroupCompanyDataExCodeOverride. operationId: UpdateGroupCompanyDataExCodeOverride parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupCompanyDataExCodeOverrideKey in: path description: GroupCompanyDataExCodeOverride Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverride' text/json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverride' application/*+json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverride' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverrideVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverrideVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupCompanyDataExCodeOverrideVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Company Data Ex-Code Overrides summary: Delete GroupCompanyDataExCodeOverride description: Deletes an GroupCompanyDataExCodeOverride operationId: DeleteGroupCompanyDataExCodeOverride parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupCompanyDataExCodeOverrideKey in: path description: GroupCompanyDataExCodeOverride Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/company-data-ex-code-overrides-batch': put: tags: - Group Company Data Ex-Code Overrides summary: Create or Update Batch GroupCompanyDataExCodeOverride description: 'Create or Update multiple GroupCompanyDataExCodeOverride at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupCompanyDataExCodeOverride parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupCompanyDataExCodeOverride' text/json: schema: type: array items: $ref: '#/components/schemas/GroupCompanyDataExCodeOverride' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupCompanyDataExCodeOverride' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts': post: tags: - Group Contracts summary: Create GroupContract description: Creates a new GroupContract operationId: CreateGroupContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupContract' text/json: schema: $ref: '#/components/schemas/GroupContract' application/*+json: schema: $ref: '#/components/schemas/GroupContract' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Contracts summary: List GroupContract description: Lists all GroupContract for the given groupID and divisionID operationId: ListGroupContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/add-contract': post: tags: - Group Contracts - Adv. Group Contracts summary: Add Next GroupContract description: 'Adds the next GroupContract, starting the day after that existing contract. A VBAProcess object is returned representing the process state. See VBAProcess area for more information.' operationId: AddNextGroupContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupAddContract' text/json: schema: $ref: '#/components/schemas/GroupAddContract' application/*+json: schema: $ref: '#/components/schemas/GroupAddContract' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/groups/{groupID}/divisions/{divisionID}/set-coverage': post: tags: - Group Contracts - Adv. Group Contracts summary: Set GroupContract Coverage End description: Changes the Coverage End for a contract. A VBAProcess object is returned representing the process state. See VBAProcess area for more information. operationId: SetCoverageGroupContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupContract' text/json: schema: $ref: '#/components/schemas/GroupContract' application/*+json: schema: $ref: '#/components/schemas/GroupContract' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/groups/{groupID}/divisions/{divisionID}/change-coverage-start': post: tags: - Group Contracts - Adv. Group Contracts summary: Change GroupContract Coverage Start description: Changes the Coverage Start for a contract. A VBAProcess object is returned representing the process state. See VBAProcess area for more information. operationId: ChangeCoverageStartGroupContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupChangeCoverageStart' text/json: schema: $ref: '#/components/schemas/GroupChangeCoverageStart' application/*+json: schema: $ref: '#/components/schemas/GroupChangeCoverageStart' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/groups/{groupID}/divisions/{divisionID}/vba-contracts': get: tags: - Group Contracts summary: List VBA_GroupContract description: Lists all VBA_GroupContract for the given groupID and divisionID operationId: ListVBAGroupContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_GroupContractListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_GroupContractListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_GroupContractListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}': get: tags: - Group Contracts summary: Get GroupContract description: Gets GroupContract operationId: GetGroupContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Contracts summary: Update GroupContract description: Updates a specific GroupContract. operationId: UpdateGroupContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupContract' text/json: schema: $ref: '#/components/schemas/GroupContract' application/*+json: schema: $ref: '#/components/schemas/GroupContract' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Contracts summary: Delete GroupContract description: Deletes an GroupContract operationId: DeleteGroupContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts-batch': put: tags: - Group Contracts summary: Create or Update Batch GroupContract description: 'Create or Update multiple GroupContract at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupContract' text/json: schema: type: array items: $ref: '#/components/schemas/GroupContract' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupContract' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans': post: tags: - Group Contract Plans summary: Create GroupContractPlan description: Creates a new GroupContractPlan operationId: CreateGroupContractPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupContractPlan' text/json: schema: $ref: '#/components/schemas/GroupContractPlan' application/*+json: schema: $ref: '#/components/schemas/GroupContractPlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Contract Plans summary: List GroupContractPlan description: Lists all GroupContractPlan for the given groupID and divisionID and coverageStart operationId: ListGroupContractPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/plans-no-contracts': get: tags: - Group Contract Plans summary: List Plans by Group and Division description: A unique list of Plans for all GroupContractPlan for the given groupID and divisionID operationId: ListPlanNoContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlansListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlansListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlansListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}': get: tags: - Group Contract Plans summary: Get GroupContractPlan description: Gets GroupContractPlan operationId: GetGroupContractPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Contract Plans summary: Update GroupContractPlan description: Updates a specific GroupContractPlan. operationId: UpdateGroupContractPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupContractPlan' text/json: schema: $ref: '#/components/schemas/GroupContractPlan' application/*+json: schema: $ref: '#/components/schemas/GroupContractPlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Contract Plans summary: Delete GroupContractPlan description: Deletes an GroupContractPlan operationId: DeleteGroupContractPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans-batch': put: tags: - Group Contract Plans summary: Create or Update Batch GroupContractPlan description: 'Create or Update multiple GroupContractPlan at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupContractPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupContractPlan' text/json: schema: type: array items: $ref: '#/components/schemas/GroupContractPlan' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupContractPlan' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/premiums': post: tags: - Group Contract Plan Premiums summary: Create GroupContractPlanPremium description: Creates a new GroupContractPlanPremium operationId: CreateGroupContractPlanPremium parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupContractPlanPremium' text/json: schema: $ref: '#/components/schemas/GroupContractPlanPremium' application/*+json: schema: $ref: '#/components/schemas/GroupContractPlanPremium' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanPremiumVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanPremiumVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanPremiumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Contract Plan Premiums summary: List GroupContractPlanPremium description: Lists all GroupContractPlanPremium for the given groupID and divisionID and coverageStart and planID operationId: ListGroupContractPlanPremium parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanPremiumListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanPremiumListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanPremiumListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/premiums/{groupContractPlanPremiumKey}': get: tags: - Group Contract Plan Premiums summary: Get GroupContractPlanPremium description: Gets GroupContractPlanPremium operationId: GetGroupContractPlanPremium parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: groupContractPlanPremiumKey in: path description: GroupContractPlanPremium Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanPremiumVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanPremiumVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanPremiumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Contract Plan Premiums summary: Update GroupContractPlanPremium description: Updates a specific GroupContractPlanPremium. operationId: UpdateGroupContractPlanPremium parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: groupContractPlanPremiumKey in: path description: GroupContractPlanPremium Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupContractPlanPremium' text/json: schema: $ref: '#/components/schemas/GroupContractPlanPremium' application/*+json: schema: $ref: '#/components/schemas/GroupContractPlanPremium' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanPremiumVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanPremiumVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanPremiumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Contract Plan Premiums summary: Delete GroupContractPlanPremium description: Deletes an GroupContractPlanPremium operationId: DeleteGroupContractPlanPremium parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: groupContractPlanPremiumKey in: path description: GroupContractPlanPremium Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/premiums-batch': put: tags: - Group Contract Plan Premiums summary: Create or Update Batch GroupContractPlanPremium description: 'Create or Update multiple GroupContractPlanPremium at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupContractPlanPremium parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupContractPlanPremium' text/json: schema: type: array items: $ref: '#/components/schemas/GroupContractPlanPremium' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupContractPlanPremium' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders': post: tags: - Group Contract Plan Riders summary: Create GroupContractPlanRider description: Creates a new GroupContractPlanRider operationId: CreateGroupContractPlanRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupContractPlanRider' text/json: schema: $ref: '#/components/schemas/GroupContractPlanRider' application/*+json: schema: $ref: '#/components/schemas/GroupContractPlanRider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanRiderVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Contract Plan Riders summary: List GroupContractPlanRider description: Lists all GroupContractPlanRider for the given groupID and divisionID and coverageStart and planID operationId: ListGroupContractPlanRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanRiderListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}': get: tags: - Group Contract Plan Riders summary: Get GroupContractPlanRider description: Gets GroupContractPlanRider operationId: GetGroupContractPlanRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanRiderVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Contract Plan Riders summary: Update GroupContractPlanRider description: Updates a specific GroupContractPlanRider. operationId: UpdateGroupContractPlanRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupContractPlanRider' text/json: schema: $ref: '#/components/schemas/GroupContractPlanRider' application/*+json: schema: $ref: '#/components/schemas/GroupContractPlanRider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanRiderVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Contract Plan Riders summary: Delete GroupContractPlanRider description: Deletes an GroupContractPlanRider operationId: DeleteGroupContractPlanRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders-batch': put: tags: - Group Contract Plan Riders summary: Create or Update Batch GroupContractPlanRider description: 'Create or Update multiple GroupContractPlanRider at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupContractPlanRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupContractPlanRider' text/json: schema: type: array items: $ref: '#/components/schemas/GroupContractPlanRider' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupContractPlanRider' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}/external-ids': post: tags: - Group Contract Plan Rider External IDs summary: Create GroupContractPlanRiderExternalID description: Creates a new GroupContractPlanRiderExternalID operationId: CreateGroupContractPlanRiderExternalID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalID' text/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalID' application/*+json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalID' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalIDVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalIDVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalIDVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Contract Plan Rider External IDs summary: List GroupContractPlanRiderExternalID description: Lists all GroupContractPlanRiderExternalID for the given groupID and divisionID and coverageStart and planID and benefitCode operationId: ListGroupContractPlanRiderExternalID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalIDListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalIDListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalIDListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}/external-ids/{externalID}': get: tags: - Group Contract Plan Rider External IDs summary: Get GroupContractPlanRiderExternalID description: Gets GroupContractPlanRiderExternalID operationId: GetGroupContractPlanRiderExternalID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: externalID in: path description: External ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalIDVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalIDVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalIDVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Contract Plan Rider External IDs summary: Update GroupContractPlanRiderExternalID description: Updates a specific GroupContractPlanRiderExternalID. operationId: UpdateGroupContractPlanRiderExternalID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: externalID in: path description: External ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalID' text/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalID' application/*+json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalID' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalIDVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalIDVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractPlanRiderExternalIDVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Contract Plan Rider External IDs summary: Delete GroupContractPlanRiderExternalID description: Deletes an GroupContractPlanRiderExternalID operationId: DeleteGroupContractPlanRiderExternalID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: externalID in: path description: External ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}/external-ids-batch': put: tags: - Group Contract Plan Rider External IDs summary: Create or Update Batch GroupContractPlanRiderExternalID description: 'Create or Update multiple GroupContractPlanRiderExternalID at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupContractPlanRiderExternalID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupContractPlanRiderExternalID' text/json: schema: type: array items: $ref: '#/components/schemas/GroupContractPlanRiderExternalID' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupContractPlanRiderExternalID' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/tiers': post: tags: - Group Contract Tiers summary: Create GroupContractTier description: Creates a new GroupContractTier operationId: CreateGroupContractTier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupContractTier' text/json: schema: $ref: '#/components/schemas/GroupContractTier' application/*+json: schema: $ref: '#/components/schemas/GroupContractTier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractTierVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractTierVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractTierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Contract Tiers summary: List GroupContractTier description: Lists all GroupContractTier for the given groupID and divisionID and coverageStart operationId: ListGroupContractTier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractTierListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractTierListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractTierListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/tiers/{tier}': get: tags: - Group Contract Tiers summary: Get GroupContractTier description: Gets GroupContractTier operationId: GetGroupContractTier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: tier in: path description: Tier required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractTierVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractTierVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractTierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Contract Tiers summary: Update GroupContractTier description: Updates a specific GroupContractTier. operationId: UpdateGroupContractTier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: tier in: path description: Tier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupContractTier' text/json: schema: $ref: '#/components/schemas/GroupContractTier' application/*+json: schema: $ref: '#/components/schemas/GroupContractTier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupContractTierVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupContractTierVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupContractTierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Contract Tiers summary: Delete GroupContractTier description: Deletes an GroupContractTier operationId: DeleteGroupContractTier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: tier in: path description: Tier required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/tiers-batch': put: tags: - Group Contract Tiers summary: Create or Update Batch GroupContractTier description: 'Create or Update multiple GroupContractTier at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupContractTier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupContractTier' text/json: schema: type: array items: $ref: '#/components/schemas/GroupContractTier' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupContractTier' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions': post: tags: - Group Divisions summary: Create GroupDivision description: Creates a new GroupDivision operationId: CreateGroupDivision parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupDivision' text/json: schema: $ref: '#/components/schemas/GroupDivision' application/*+json: schema: $ref: '#/components/schemas/GroupDivision' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Divisions summary: List GroupDivision description: Lists all GroupDivision for the given groupID operationId: ListGroupDivision parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}': get: tags: - Group Divisions summary: Get GroupDivision description: Gets GroupDivision operationId: GetGroupDivision parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Divisions summary: Update GroupDivision description: Updates a specific GroupDivision. operationId: UpdateGroupDivision parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupDivision' text/json: schema: $ref: '#/components/schemas/GroupDivision' application/*+json: schema: $ref: '#/components/schemas/GroupDivision' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Divisions summary: Delete GroupDivision description: Deletes an GroupDivision operationId: DeleteGroupDivision parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions-batch': put: tags: - Group Divisions summary: Create or Update Batch GroupDivision description: 'Create or Update multiple GroupDivision at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupDivision parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupDivision' text/json: schema: type: array items: $ref: '#/components/schemas/GroupDivision' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupDivision' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/copy': post: tags: - Group Divisions - Adv. Group Divisions summary: Copy a GroupDivision description: Copy a specific GroupDivision to a new GroupDivision operationId: CopyGroupDivision parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CopyGroupDivision' text/json: schema: $ref: '#/components/schemas/CopyGroupDivision' application/*+json: schema: $ref: '#/components/schemas/CopyGroupDivision' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/groups/{groupID}/divisions/{divisionID}/enrollment-summary': get: tags: - Group Divisions - Adv. Group Divisions summary: Get Group enrollment summary information description: 'Gets enrollment summary for the given group id and division id. ' operationId: GetGroupDivisionEnrollmentSummary parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_GroupContractEnrollmentSummaryListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_GroupContractEnrollmentSummaryListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_GroupContractEnrollmentSummaryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /group-division-captives: post: tags: - Group Division Captives summary: Create GroupDivisionCaptive description: Creates a new GroupDivisionCaptive operationId: CreateGroupDivisionCaptive parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupDivisionCaptive' text/json: schema: $ref: '#/components/schemas/GroupDivisionCaptive' application/*+json: schema: $ref: '#/components/schemas/GroupDivisionCaptive' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionCaptiveVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionCaptiveVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionCaptiveVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Division Captives summary: List GroupDivisionCaptive description: Lists all GroupDivisionCaptive operationId: ListGroupDivisionCaptive parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionCaptiveListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionCaptiveListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionCaptiveListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/group-division-captives/{groupDivisionCaptive1}': get: tags: - Group Division Captives summary: Get GroupDivisionCaptive description: Gets GroupDivisionCaptive operationId: GetGroupDivisionCaptive parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupDivisionCaptive1 in: path description: GroupDivisionCaptive1 required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionCaptiveVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionCaptiveVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionCaptiveVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Division Captives summary: Update GroupDivisionCaptive description: Updates a specific GroupDivisionCaptive. operationId: UpdateGroupDivisionCaptive parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupDivisionCaptive1 in: path description: GroupDivisionCaptive1 required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupDivisionCaptive' text/json: schema: $ref: '#/components/schemas/GroupDivisionCaptive' application/*+json: schema: $ref: '#/components/schemas/GroupDivisionCaptive' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionCaptiveVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionCaptiveVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionCaptiveVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Division Captives summary: Delete GroupDivisionCaptive description: Deletes an GroupDivisionCaptive operationId: DeleteGroupDivisionCaptive parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupDivisionCaptive1 in: path description: GroupDivisionCaptive1 required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-division-captives-batch: put: tags: - Group Division Captives summary: Create or Update Batch GroupDivisionCaptive description: 'Create or Update multiple GroupDivisionCaptive at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupDivisionCaptive parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupDivisionCaptive' text/json: schema: type: array items: $ref: '#/components/schemas/GroupDivisionCaptive' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupDivisionCaptive' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/cobra-divisions/{cobraDivisionID}': post: tags: - Group Division Cobras summary: Create GroupDivisionCobra description: Creates a new GroupDivisionCobra operationId: CreateGroupDivisionCobra parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: cobraDivisionID in: path description: Cobra Division ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionCobraVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionCobraVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionCobraVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Division Cobras summary: Get GroupDivisionCobra description: Gets GroupDivisionCobra operationId: GetGroupDivisionCobra parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: cobraDivisionID in: path description: Cobra Division ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionCobraVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionCobraVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionCobraVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Division Cobras summary: Delete GroupDivisionCobra description: Deletes an GroupDivisionCobra operationId: DeleteGroupDivisionCobra parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: cobraDivisionID in: path description: Cobra Division ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/cobra-divisions': get: tags: - Group Division Cobras summary: List GroupDivisionCobra description: Lists all GroupDivisionCobra for the given groupID and divisionID operationId: ListGroupDivisionCobra parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionCobraListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionCobraListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionCobraListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/cobra-divisions-batch': put: tags: - Group Division Cobras summary: Create Batch GroupDivisionCobra description: 'Create multiple GroupDivisionCobra at once. If the entity does not exist, it will be created. If the entity already exists, an error will come back for that item. These entities are not editable. Delete and recreate to edit.' operationId: UpdateBatchGroupDivisionCobra parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupDivisionCobra' text/json: schema: type: array items: $ref: '#/components/schemas/GroupDivisionCobra' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupDivisionCobra' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/deduction-types/{deductionType}': post: tags: - Group Division Deduction Types summary: Create GroupDivisionDeductionType description: Creates a new GroupDivisionDeductionType operationId: CreateGroupDivisionDeductionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: deductionType in: path description: Deduction Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionDeductionTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionDeductionTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionDeductionTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Division Deduction Types summary: Get GroupDivisionDeductionType description: Gets GroupDivisionDeductionType operationId: GetGroupDivisionDeductionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: deductionType in: path description: Deduction Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionDeductionTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionDeductionTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionDeductionTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Division Deduction Types summary: Delete GroupDivisionDeductionType description: Deletes an GroupDivisionDeductionType operationId: DeleteGroupDivisionDeductionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: deductionType in: path description: Deduction Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/deduction-types': get: tags: - Group Division Deduction Types summary: List GroupDivisionDeductionType description: Lists all GroupDivisionDeductionType for the given groupID and divisionID operationId: ListGroupDivisionDeductionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionDeductionTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionDeductionTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionDeductionTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/deduction-types-batch': put: tags: - Group Division Deduction Types summary: Create or Update Batch GroupDivisionDeductionType description: 'Create or Update multiple GroupDivisionDeductionType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupDivisionDeductionType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupDivisionDeductionType' text/json: schema: type: array items: $ref: '#/components/schemas/GroupDivisionDeductionType' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupDivisionDeductionType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/id-codes/{iDCode}': post: tags: - Group Division ID Codes summary: Create GroupDivisionIDCode description: Creates a new GroupDivisionIDCode operationId: CreateGroupDivisionIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: iDCode in: path description: ID Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupDivisionIDCode' text/json: schema: $ref: '#/components/schemas/GroupDivisionIDCode' application/*+json: schema: $ref: '#/components/schemas/GroupDivisionIDCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionIDCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionIDCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionIDCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Division ID Codes summary: Get GroupDivisionIDCode description: Gets GroupDivisionIDCode operationId: GetGroupDivisionIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: iDCode in: path description: ID Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionIDCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionIDCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionIDCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Division ID Codes summary: Update GroupDivisionIDCode description: Updates a specific GroupDivisionIDCode. operationId: UpdateGroupDivisionIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: iDCode in: path description: ID Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupDivisionIDCode' text/json: schema: $ref: '#/components/schemas/GroupDivisionIDCode' application/*+json: schema: $ref: '#/components/schemas/GroupDivisionIDCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionIDCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionIDCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionIDCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Division ID Codes summary: Delete GroupDivisionIDCode description: Deletes an GroupDivisionIDCode operationId: DeleteGroupDivisionIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: iDCode in: path description: ID Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/id-codes': get: tags: - Group Division ID Codes summary: List GroupDivisionIDCode description: Lists all GroupDivisionIDCode for the given groupID and divisionID operationId: ListGroupDivisionIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDivisionIDCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupDivisionIDCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupDivisionIDCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/id-codes-batch': put: tags: - Group Division ID Codes summary: Create or Update Batch GroupDivisionIDCode description: 'Create or Update multiple GroupDivisionIDCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupDivisionIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupDivisionIDCode' text/json: schema: type: array items: $ref: '#/components/schemas/GroupDivisionIDCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupDivisionIDCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-ex-code-criterias: post: tags: - Group Ex-Code Criterias summary: Create GroupExCodeCriteria description: Creates a new GroupExCodeCriteria operationId: CreateGroupExCodeCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupExCodeCriteria' text/json: schema: $ref: '#/components/schemas/GroupExCodeCriteria' application/*+json: schema: $ref: '#/components/schemas/GroupExCodeCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupExCodeCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupExCodeCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupExCodeCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Ex-Code Criterias summary: List GroupExCodeCriteria description: Lists all GroupExCodeCriteria operationId: ListGroupExCodeCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupExCodeCriteriaListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupExCodeCriteriaListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupExCodeCriteriaListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/group-ex-code-criterias/{groupExCodeCriteriaKey}': get: tags: - Group Ex-Code Criterias summary: Get GroupExCodeCriteria description: Gets GroupExCodeCriteria operationId: GetGroupExCodeCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupExCodeCriteriaKey in: path description: GroupExCodeCriteria Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupExCodeCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupExCodeCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupExCodeCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Ex-Code Criterias summary: Update GroupExCodeCriteria description: Updates a specific GroupExCodeCriteria. operationId: UpdateGroupExCodeCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupExCodeCriteriaKey in: path description: GroupExCodeCriteria Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupExCodeCriteria' text/json: schema: $ref: '#/components/schemas/GroupExCodeCriteria' application/*+json: schema: $ref: '#/components/schemas/GroupExCodeCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupExCodeCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupExCodeCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupExCodeCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Ex-Code Criterias summary: Delete GroupExCodeCriteria description: Deletes an GroupExCodeCriteria operationId: DeleteGroupExCodeCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupExCodeCriteriaKey in: path description: GroupExCodeCriteria Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-ex-code-criterias-batch: put: tags: - Group Ex-Code Criterias summary: Create or Update Batch GroupExCodeCriteria description: 'Create or Update multiple GroupExCodeCriteria at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupExCodeCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupExCodeCriteria' text/json: schema: type: array items: $ref: '#/components/schemas/GroupExCodeCriteria' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupExCodeCriteria' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/flexes': post: tags: - Group Flexes summary: Create GroupFlex description: Creates a new GroupFlex operationId: CreateGroupFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupFlex' text/json: schema: $ref: '#/components/schemas/GroupFlex' application/*+json: schema: $ref: '#/components/schemas/GroupFlex' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupFlexVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupFlexVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupFlexVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Flexes summary: List GroupFlex description: Lists all GroupFlex for the given groupID operationId: ListGroupFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupFlexListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupFlexListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupFlexListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/flexes/{planID}/{calendarYear}': get: tags: - Group Flexes summary: Get GroupFlex description: Gets GroupFlex operationId: GetGroupFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: calendarYear in: path description: Calendar Year required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupFlexVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupFlexVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupFlexVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Flexes summary: Update GroupFlex description: Updates a specific GroupFlex. operationId: UpdateGroupFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: calendarYear in: path description: Calendar Year required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupFlex' text/json: schema: $ref: '#/components/schemas/GroupFlex' application/*+json: schema: $ref: '#/components/schemas/GroupFlex' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupFlexVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupFlexVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupFlexVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Flexes summary: Delete GroupFlex description: Deletes an GroupFlex operationId: DeleteGroupFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: calendarYear in: path description: Calendar Year required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/flexes-batch': put: tags: - Group Flexes summary: Create or Update Batch GroupFlex description: 'Create or Update multiple GroupFlex at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupFlex' text/json: schema: type: array items: $ref: '#/components/schemas/GroupFlex' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupFlex' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/flex-auto-creates': post: tags: - Group Flex Auto-Create summary: Create GroupFlexCreate description: Creates a new GroupFlexCreate operationId: CreateGroupFlexCreate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupFlexCreate' text/json: schema: $ref: '#/components/schemas/GroupFlexCreate' application/*+json: schema: $ref: '#/components/schemas/GroupFlexCreate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupFlexCreateVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupFlexCreateVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupFlexCreateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Flex Auto-Create summary: List GroupFlexCreate description: Lists all GroupFlexCreate for the given groupID operationId: ListGroupFlexCreate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupFlexCreateListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupFlexCreateListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupFlexCreateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/flex-auto-creates/{groupFlexCreateKey}': get: tags: - Group Flex Auto-Create summary: Get GroupFlexCreate description: Gets GroupFlexCreate operationId: GetGroupFlexCreate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupFlexCreateKey in: path description: GroupFlexCreate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupFlexCreateVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupFlexCreateVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupFlexCreateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Flex Auto-Create summary: Update GroupFlexCreate description: Updates a specific GroupFlexCreate. operationId: UpdateGroupFlexCreate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupFlexCreateKey in: path description: GroupFlexCreate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupFlexCreate' text/json: schema: $ref: '#/components/schemas/GroupFlexCreate' application/*+json: schema: $ref: '#/components/schemas/GroupFlexCreate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupFlexCreateVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupFlexCreateVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupFlexCreateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Flex Auto-Create summary: Delete GroupFlexCreate description: Deletes an GroupFlexCreate operationId: DeleteGroupFlexCreate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupFlexCreateKey in: path description: GroupFlexCreate Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/flex-auto-creates-batch': put: tags: - Group Flex Auto-Create summary: Create or Update Batch GroupFlexCreate description: 'Create or Update multiple GroupFlexCreate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupFlexCreate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupFlexCreate' text/json: schema: type: array items: $ref: '#/components/schemas/GroupFlexCreate' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupFlexCreate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/flex-schedules': post: tags: - Group Flex Schedules summary: Create GroupFlexSchedule description: Creates a new GroupFlexSchedule operationId: CreateGroupFlexSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupFlexSchedule' text/json: schema: $ref: '#/components/schemas/GroupFlexSchedule' application/*+json: schema: $ref: '#/components/schemas/GroupFlexSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupFlexScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupFlexScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupFlexScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Flex Schedules summary: List GroupFlexSchedule description: Lists all GroupFlexSchedule for the given groupID operationId: ListGroupFlexSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupFlexScheduleListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupFlexScheduleListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupFlexScheduleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/flex-schedules/{groupFlexScheduleKey}': get: tags: - Group Flex Schedules summary: Get GroupFlexSchedule description: Gets GroupFlexSchedule operationId: GetGroupFlexSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupFlexScheduleKey in: path description: GroupFlexSchedule Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupFlexScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupFlexScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupFlexScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Flex Schedules summary: Update GroupFlexSchedule description: Updates a specific GroupFlexSchedule. operationId: UpdateGroupFlexSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupFlexScheduleKey in: path description: GroupFlexSchedule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupFlexSchedule' text/json: schema: $ref: '#/components/schemas/GroupFlexSchedule' application/*+json: schema: $ref: '#/components/schemas/GroupFlexSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupFlexScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupFlexScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupFlexScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Flex Schedules summary: Delete GroupFlexSchedule description: Deletes an GroupFlexSchedule operationId: DeleteGroupFlexSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupFlexScheduleKey in: path description: GroupFlexSchedule Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/flex-schedules-batch': put: tags: - Group Flex Schedules summary: Create or Update Batch GroupFlexSchedule description: 'Create or Update multiple GroupFlexSchedule at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupFlexSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupFlexSchedule' text/json: schema: type: array items: $ref: '#/components/schemas/GroupFlexSchedule' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupFlexSchedule' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/networks': post: tags: - Group Networks summary: Create GroupNetwork description: Creates a new GroupNetwork operationId: CreateGroupNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupNetwork' text/json: schema: $ref: '#/components/schemas/GroupNetwork' application/*+json: schema: $ref: '#/components/schemas/GroupNetwork' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Networks summary: List GroupNetwork description: Lists all GroupNetwork for the given groupID and divisionID and coverageStart operationId: ListGroupNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/networks/{networkID}/{state}': get: tags: - Group Networks summary: Get GroupNetwork description: Gets GroupNetwork operationId: GetGroupNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: networkID in: path description: NetworkID required: true schema: type: string - name: state in: path description: State required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Networks summary: Update GroupNetwork description: Updates a specific GroupNetwork. operationId: UpdateGroupNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: networkID in: path description: NetworkID required: true schema: type: string - name: state in: path description: State required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupNetwork' text/json: schema: $ref: '#/components/schemas/GroupNetwork' application/*+json: schema: $ref: '#/components/schemas/GroupNetwork' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Networks summary: Delete GroupNetwork description: Deletes an GroupNetwork operationId: DeleteGroupNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: networkID in: path description: NetworkID required: true schema: type: string - name: state in: path description: State required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/networks-batch': put: tags: - Group Networks summary: Create or Update Batch GroupNetwork description: 'Create or Update multiple GroupNetwork at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupNetwork' text/json: schema: type: array items: $ref: '#/components/schemas/GroupNetwork' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupNetwork' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/networks/{networkID}/{state}/add-ons': post: tags: - Group Network Add-Ons summary: Create GroupNetworkAddOn description: Creates a new GroupNetworkAddOn operationId: CreateGroupNetworkAddOn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: networkID in: path description: NetworkID required: true schema: type: string - name: state in: path description: State required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupNetworkAddOn' text/json: schema: $ref: '#/components/schemas/GroupNetworkAddOn' application/*+json: schema: $ref: '#/components/schemas/GroupNetworkAddOn' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkAddOnVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkAddOnVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkAddOnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Network Add-Ons summary: List GroupNetworkAddOn description: Lists all GroupNetworkAddOn for the given groupID operationId: ListGroupNetworkAddOn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: networkID in: path description: NetworkID required: true schema: type: string - name: state in: path description: State required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkAddOnListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkAddOnListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkAddOnListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/networks/{networkID}/{state}/add-ons/{groupNetworkAddOnKey}': get: tags: - Group Network Add-Ons summary: Get GroupNetworkAddOn description: Gets GroupNetworkAddOn operationId: GetGroupNetworkAddOn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: networkID in: path description: NetworkID required: true schema: type: string - name: state in: path description: State required: true schema: type: string - name: groupNetworkAddOnKey in: path description: GroupNetworkAddOn Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkAddOnVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkAddOnVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkAddOnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Network Add-Ons summary: Update GroupNetworkAddOn description: Updates a specific GroupNetworkAddOn. operationId: UpdateGroupNetworkAddOn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: networkID in: path description: NetworkID required: true schema: type: string - name: state in: path description: State required: true schema: type: string - name: groupNetworkAddOnKey in: path description: GroupNetworkAddOn Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupNetworkAddOn' text/json: schema: $ref: '#/components/schemas/GroupNetworkAddOn' application/*+json: schema: $ref: '#/components/schemas/GroupNetworkAddOn' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkAddOnVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkAddOnVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkAddOnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Network Add-Ons summary: Delete GroupNetworkAddOn description: Deletes an GroupNetworkAddOn operationId: DeleteGroupNetworkAddOn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: networkID in: path description: NetworkID required: true schema: type: string - name: state in: path description: State required: true schema: type: string - name: groupNetworkAddOnKey in: path description: GroupNetworkAddOn Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/networks/{networkID}/{state}/add-ons-batch': put: tags: - Group Network Add-Ons summary: Create or Update Batch GroupNetworkAddOn description: 'Create or Update multiple GroupNetworkAddOn at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupNetworkAddOn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: coverageStart in: path description: Coverage Start required: true schema: type: string format: date-time - name: networkID in: path description: NetworkID required: true schema: type: string - name: state in: path description: State required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupNetworkAddOn' text/json: schema: type: array items: $ref: '#/components/schemas/GroupNetworkAddOn' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupNetworkAddOn' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-network-criterias: post: tags: - Group Network Criterias summary: Create GroupNetworkCriteria description: Creates a new GroupNetworkCriteria operationId: CreateGroupNetworkCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupNetworkCriteria' text/json: schema: $ref: '#/components/schemas/GroupNetworkCriteria' application/*+json: schema: $ref: '#/components/schemas/GroupNetworkCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Network Criterias summary: List GroupNetworkCriteria description: Retrieves a paginated list of GroupNetworkCriteria with optional sorting and filtering by Group_ID and Division_ID. operationId: ListGroupNetworkCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: Group_ID in: query description: Optional filter for Group_ID. schema: type: string - name: Division_ID in: query description: Optional filter for Division_ID. schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkCriteriaListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkCriteriaListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkCriteriaListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/group-network-criterias/{groupNetworkCriteriaKey}': get: tags: - Group Network Criterias summary: Get GroupNetworkCriteria description: Gets GroupNetworkCriteria operationId: GetGroupNetworkCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupNetworkCriteriaKey in: path description: GroupNetworkCriteria Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Network Criterias summary: Update GroupNetworkCriteria description: Updates a specific GroupNetworkCriteria. operationId: UpdateGroupNetworkCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupNetworkCriteriaKey in: path description: GroupNetworkCriteria Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupNetworkCriteria' text/json: schema: $ref: '#/components/schemas/GroupNetworkCriteria' application/*+json: schema: $ref: '#/components/schemas/GroupNetworkCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Network Criterias summary: Delete GroupNetworkCriteria description: Deletes an GroupNetworkCriteria operationId: DeleteGroupNetworkCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupNetworkCriteriaKey in: path description: GroupNetworkCriteria Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-network-criterias-batch: put: tags: - Group Network Criterias summary: Create or Update Batch GroupNetworkCriteria description: 'Create or Update multiple GroupNetworkCriteria at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupNetworkCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupNetworkCriteria' text/json: schema: type: array items: $ref: '#/components/schemas/GroupNetworkCriteria' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupNetworkCriteria' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-criteria-columns: get: tags: - Group Network Criteria Columns summary: List GroupNetworkCriteriaColumn description: Lists all GroupNetworkCriteriaColumn for the given groupNetworkCriteriaColumnKey operationId: ListGroupNetworkCriteriaColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkCriteriaColumnListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkCriteriaColumnListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkCriteriaColumnListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/group-criteria-columns/{groupNetworkCriteriaColumnKey}': get: tags: - Group Network Criteria Columns summary: Get GroupNetworkCriteriaColumn description: Gets GroupNetworkCriteriaColumn operationId: GetGroupNetworkCriteriaColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupNetworkCriteriaColumnKey in: path description: GroupNetworkCriteriaColumn Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupNetworkCriteriaColumnVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupNetworkCriteriaColumnVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupNetworkCriteriaColumnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings': post: tags: - Group Payor Account Settings summary: Create GroupPayorAccount description: Creates a new GroupPayorAccount operationId: CreateGroupPayorAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPayorAccount' text/json: schema: $ref: '#/components/schemas/GroupPayorAccount' application/*+json: schema: $ref: '#/components/schemas/GroupPayorAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Payor Account Settings summary: List GroupPayorAccount description: Lists all GroupPayorAccount for the given groupID operationId: ListGroupPayorAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}': get: tags: - Group Payor Account Settings summary: Get GroupPayorAccount description: Gets GroupPayorAccount operationId: GetGroupPayorAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Payor Account Settings summary: Update GroupPayorAccount description: Updates a specific GroupPayorAccount. operationId: UpdateGroupPayorAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPayorAccount' text/json: schema: $ref: '#/components/schemas/GroupPayorAccount' application/*+json: schema: $ref: '#/components/schemas/GroupPayorAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Payor Account Settings summary: Delete GroupPayorAccount description: Deletes an GroupPayorAccount operationId: DeleteGroupPayorAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings-batch': put: tags: - Group Payor Account Settings summary: Create or Update Batch GroupPayorAccount description: 'Create or Update multiple GroupPayorAccount at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupPayorAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccount' text/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccount' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccount' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/benefits': post: tags: - Group Payor Account Benefits summary: Create GroupPayorAccountBenefit description: Creates a new GroupPayorAccountBenefit operationId: CreateGroupPayorAccountBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefit' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefit' application/*+json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Payor Account Benefits summary: List GroupPayorAccountBenefit description: Lists all GroupPayorAccountBenefit for the given groupID and settingID operationId: ListGroupPayorAccountBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountBenefitListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefitListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefitListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/benefits/{benefitCode}': get: tags: - Group Payor Account Benefits summary: Get GroupPayorAccountBenefit description: Gets GroupPayorAccountBenefit operationId: GetGroupPayorAccountBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Payor Account Benefits summary: Update GroupPayorAccountBenefit description: Updates a specific GroupPayorAccountBenefit. operationId: UpdateGroupPayorAccountBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefit' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefit' application/*+json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Payor Account Benefits summary: Delete GroupPayorAccountBenefit description: Deletes an GroupPayorAccountBenefit operationId: DeleteGroupPayorAccountBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/benefits-batch': put: tags: - Group Payor Account Benefits summary: Create or Update Batch GroupPayorAccountBenefit description: 'Create or Update multiple GroupPayorAccountBenefit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupPayorAccountBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountBenefit' text/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountBenefit' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountBenefit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/networks': post: tags: - Group Payor Account Networks summary: Create GroupPayorAccountNetwork description: Creates a new GroupPayorAccountNetwork operationId: CreateGroupPayorAccountNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPayorAccountNetwork' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountNetwork' application/*+json: schema: $ref: '#/components/schemas/GroupPayorAccountNetwork' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Payor Account Networks summary: List GroupPayorAccountNetwork description: Lists all GroupPayorAccountNetwork for the given groupID and settingID operationId: ListGroupPayorAccountNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountNetworkListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountNetworkListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountNetworkListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/networks/{networkID}': get: tags: - Group Payor Account Networks summary: Get GroupPayorAccountNetwork description: Gets GroupPayorAccountNetwork operationId: GetGroupPayorAccountNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Payor Account Networks summary: Delete GroupPayorAccountNetwork description: Deletes an GroupPayorAccountNetwork operationId: DeleteGroupPayorAccountNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/networks-batch': put: tags: - Group Payor Account Networks summary: Create or Update Batch GroupPayorAccountNetwork description: 'Create or Update multiple GroupPayorAccountNetwork at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupPayorAccountNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountNetwork' text/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountNetwork' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountNetwork' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/pay-tos': post: tags: - Group Payor Account Pay To summary: Create GroupPayorAccountPayTo description: Creates a new GroupPayorAccountPayTo operationId: CreateGroupPayorAccountPayTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPayorAccountPayTo' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountPayTo' application/*+json: schema: $ref: '#/components/schemas/GroupPayorAccountPayTo' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountPayToVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountPayToVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountPayToVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Payor Account Pay To summary: List GroupPayorAccountPayTo description: Lists all GroupPayorAccountPayTo for the given groupID and settingID operationId: ListGroupPayorAccountPayTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountPayToListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountPayToListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountPayToListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/pay-tos/{sendCheckTo}': get: tags: - Group Payor Account Pay To summary: Get GroupPayorAccountPayTo description: Gets GroupPayorAccountPayTo operationId: GetGroupPayorAccountPayTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: sendCheckTo in: path description: Send Check To required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountPayToVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountPayToVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountPayToVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Payor Account Pay To summary: Delete GroupPayorAccountPayTo description: Deletes an GroupPayorAccountPayTo operationId: DeleteGroupPayorAccountPayTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: sendCheckTo in: path description: Send Check To required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/pay-tos-batch': put: tags: - Group Payor Account Pay To summary: Create or Update Batch GroupPayorAccountPayTo description: 'Create or Update multiple GroupPayorAccountPayTo at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupPayorAccountPayTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountPayTo' text/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountPayTo' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountPayTo' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/plan-types': post: tags: - Group Payor Account Plan Types summary: Create GroupPayorAccountPlanType description: Creates a new GroupPayorAccountPlanType operationId: CreateGroupPayorAccountPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPayorAccountPlanType' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountPlanType' application/*+json: schema: $ref: '#/components/schemas/GroupPayorAccountPlanType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountPlanTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountPlanTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountPlanTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Payor Account Plan Types summary: List GroupPayorAccountPlanType description: Lists all GroupPayorAccountPlanType for the given groupID and settingID operationId: ListGroupPayorAccountPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountPlanTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountPlanTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountPlanTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/plan-types/{planType}': get: tags: - Group Payor Account Plan Types summary: Get GroupPayorAccountPlanType description: Gets GroupPayorAccountPlanType operationId: GetGroupPayorAccountPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountPlanTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountPlanTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountPlanTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Payor Account Plan Types summary: Delete GroupPayorAccountPlanType description: Deletes an GroupPayorAccountPlanType operationId: DeleteGroupPayorAccountPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/plan-types-batch': put: tags: - Group Payor Account Plan Types summary: Create or Update Batch GroupPayorAccountPlanType description: 'Create or Update multiple GroupPayorAccountPlanType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupPayorAccountPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountPlanType' text/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountPlanType' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountPlanType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/federal-ids': post: tags: - Group Payor Account Provider Federal IDs summary: Create GroupPayorAccountProviderFederal description: Creates a new GroupPayorAccountProviderFederal operationId: CreateGroupPayorAccountProviderFederal parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPayorAccountProviderFederal' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountProviderFederal' application/*+json: schema: $ref: '#/components/schemas/GroupPayorAccountProviderFederal' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountProviderFederalVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountProviderFederalVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountProviderFederalVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Payor Account Provider Federal IDs summary: List GroupPayorAccountProviderFederal description: Lists all GroupPayorAccountProviderFederal for the given groupID and settingID operationId: ListGroupPayorAccountProviderFederal parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountProviderFederalListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountProviderFederalListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountProviderFederalListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/federal-ids/{federalID}': get: tags: - Group Payor Account Provider Federal IDs summary: Get GroupPayorAccountProviderFederal description: Gets GroupPayorAccountProviderFederal operationId: GetGroupPayorAccountProviderFederal parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: federalID in: path description: Federal ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountProviderFederalVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountProviderFederalVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountProviderFederalVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Payor Account Provider Federal IDs summary: Delete GroupPayorAccountProviderFederal description: Deletes an GroupPayorAccountProviderFederal operationId: DeleteGroupPayorAccountProviderFederal parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: federalID in: path description: Federal ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/federal-ids-batch': put: tags: - Group Payor Account Provider Federal IDs summary: Create or Update Batch GroupPayorAccountProviderFederal description: 'Create or Update multiple GroupPayorAccountProviderFederal at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupPayorAccountProviderFederal parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountProviderFederal' text/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountProviderFederal' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountProviderFederal' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/senders': post: tags: - Group Payor Account Senders summary: Create GroupPayorAccountSender description: Creates a new GroupPayorAccountSender operationId: CreateGroupPayorAccountSender parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPayorAccountSender' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountSender' application/*+json: schema: $ref: '#/components/schemas/GroupPayorAccountSender' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountSenderVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountSenderVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountSenderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Payor Account Senders summary: List GroupPayorAccountSender description: Lists all GroupPayorAccountSender for the given groupID and settingID operationId: ListGroupPayorAccountSender parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountSenderListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountSenderListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountSenderListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/senders/{senderID}': get: tags: - Group Payor Account Senders summary: Get GroupPayorAccountSender description: Gets GroupPayorAccountSender operationId: GetGroupPayorAccountSender parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: senderID in: path description: Sender ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPayorAccountSenderVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPayorAccountSenderVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPayorAccountSenderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Payor Account Senders summary: Delete GroupPayorAccountSender description: Deletes an GroupPayorAccountSender operationId: DeleteGroupPayorAccountSender parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string - name: senderID in: path description: Sender ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/payor-account-settings/{settingID}/senders-batch': put: tags: - Group Payor Account Senders summary: Create or Update Batch GroupPayorAccountSender description: 'Create or Update multiple GroupPayorAccountSender at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupPayorAccountSender parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: settingID in: path description: Setting ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountSender' text/json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountSender' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupPayorAccountSender' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/plan-years': post: tags: - Group Plan Years summary: Create GroupPlanYear description: Creates a new GroupPlanYear operationId: CreateGroupPlanYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPlanYear' text/json: schema: $ref: '#/components/schemas/GroupPlanYear' application/*+json: schema: $ref: '#/components/schemas/GroupPlanYear' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPlanYearVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPlanYearVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPlanYearVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Plan Years summary: List GroupPlanYear description: Lists all GroupPlanYear for the given groupID and divisionID operationId: ListGroupPlanYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPlanYearListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPlanYearListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPlanYearListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/plan-years/{planYear}': get: tags: - Group Plan Years summary: Get GroupPlanYear description: Gets GroupPlanYear operationId: GetGroupPlanYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPlanYearVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPlanYearVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPlanYearVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Plan Years summary: Update GroupPlanYear description: Updates a specific GroupPlanYear. operationId: UpdateGroupPlanYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPlanYear' text/json: schema: $ref: '#/components/schemas/GroupPlanYear' application/*+json: schema: $ref: '#/components/schemas/GroupPlanYear' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPlanYearVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPlanYearVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPlanYearVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Plan Years summary: Delete GroupPlanYear description: Deletes an GroupPlanYear operationId: DeleteGroupPlanYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/plan-years-batch': put: tags: - Group Plan Years summary: Create or Update Batch GroupPlanYear description: 'Create or Update multiple GroupPlanYear at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupPlanYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupPlanYear' text/json: schema: type: array items: $ref: '#/components/schemas/GroupPlanYear' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupPlanYear' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/plan-years/{planYear}/prior-accum-auto-generators': post: tags: - Group Plan Prior Accum Auto Generators summary: Create GroupPlanYearAutoPriorAccum description: Creates a new GroupPlanYearAutoPriorAccum operationId: CreateGroupPlanYearAutoPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccum' text/json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccum' application/*+json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Plan Prior Accum Auto Generators summary: List GroupPlanYearAutoPriorAccum description: Lists all GroupPlanYearAutoPriorAccum for the given groupID and divisionID and planYear operationId: ListGroupPlanYearAutoPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccumListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccumListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccumListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/plan-years/{planYear}/prior-accum-auto-generators/{groupPlanYearAutoPriorAccumKey}': get: tags: - Group Plan Prior Accum Auto Generators summary: Get GroupPlanYearAutoPriorAccum description: Gets GroupPlanYearAutoPriorAccum operationId: GetGroupPlanYearAutoPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: groupPlanYearAutoPriorAccumKey in: path description: GroupPlanYearAutoPriorAccum Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Plan Prior Accum Auto Generators summary: Update GroupPlanYearAutoPriorAccum description: Updates a specific GroupPlanYearAutoPriorAccum. operationId: UpdateGroupPlanYearAutoPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: groupPlanYearAutoPriorAccumKey in: path description: GroupPlanYearAutoPriorAccum Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccum' text/json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccum' application/*+json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Plan Prior Accum Auto Generators summary: Delete GroupPlanYearAutoPriorAccum description: Deletes an GroupPlanYearAutoPriorAccum operationId: DeleteGroupPlanYearAutoPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: groupPlanYearAutoPriorAccumKey in: path description: GroupPlanYearAutoPriorAccum Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/divisions/{divisionID}/plan-years/{planYear}/prior-accum-auto-generators-batch': put: tags: - Group Plan Prior Accum Auto Generators summary: Create or Update Batch GroupPlanYearAutoPriorAccum description: 'Create or Update multiple GroupPlanYearAutoPriorAccum at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupPlanYearAutoPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccum' text/json: schema: type: array items: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccum' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccum' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/reports/{reportDefinitionKey}/premium-categories': post: tags: - Group Premium Rate Categories summary: Create GroupPremRateCategory description: Creates a new GroupPremRateCategory operationId: CreateGroupPremRateCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPremRateCategory' text/json: schema: $ref: '#/components/schemas/GroupPremRateCategory' application/*+json: schema: $ref: '#/components/schemas/GroupPremRateCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPremRateCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPremRateCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPremRateCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Premium Rate Categories summary: List GroupPremRateCategory description: Lists all GroupPremRateCategory for the given groupID and reportDefinitionKey operationId: ListGroupPremRateCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPremRateCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPremRateCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPremRateCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/reports/{reportDefinitionKey}/premium-categories/{sequence}': get: tags: - Group Premium Rate Categories summary: Get GroupPremRateCategory description: Gets GroupPremRateCategory operationId: GetGroupPremRateCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: sequence in: path description: Sequence required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPremRateCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPremRateCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPremRateCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Premium Rate Categories summary: Delete GroupPremRateCategory description: Deletes an GroupPremRateCategory operationId: DeleteGroupPremRateCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: sequence in: path description: Sequence required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/reports/{reportDefinitionKey}/premium-categories-batch': put: tags: - Group Premium Rate Categories summary: Create or Update Batch GroupPremRateCategory description: 'Create or Update multiple GroupPremRateCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupPremRateCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupPremRateCategory' text/json: schema: type: array items: $ref: '#/components/schemas/GroupPremRateCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupPremRateCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/price-adjustments': post: tags: - Group Price Adjustments summary: Create GroupPriceAdjust description: Creates a new GroupPriceAdjust operationId: CreateGroupPriceAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPriceAdjust' text/json: schema: $ref: '#/components/schemas/GroupPriceAdjust' application/*+json: schema: $ref: '#/components/schemas/GroupPriceAdjust' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPriceAdjustVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPriceAdjustVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPriceAdjustVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Price Adjustments summary: List GroupPriceAdjust description: Lists all GroupPriceAdjust for the given groupID operationId: ListGroupPriceAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPriceAdjustListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPriceAdjustListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPriceAdjustListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/price-adjustments/{effectiveDate}': get: tags: - Group Price Adjustments summary: Get GroupPriceAdjust description: Gets GroupPriceAdjust operationId: GetGroupPriceAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPriceAdjustVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPriceAdjustVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPriceAdjustVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Price Adjustments summary: Update GroupPriceAdjust description: Updates a specific GroupPriceAdjust. operationId: UpdateGroupPriceAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPriceAdjust' text/json: schema: $ref: '#/components/schemas/GroupPriceAdjust' application/*+json: schema: $ref: '#/components/schemas/GroupPriceAdjust' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupPriceAdjustVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupPriceAdjustVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupPriceAdjustVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Price Adjustments summary: Delete GroupPriceAdjust description: Deletes an GroupPriceAdjust operationId: DeleteGroupPriceAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/price-adjustments-batch': put: tags: - Group Price Adjustments summary: Create or Update Batch GroupPriceAdjust description: 'Create or Update multiple GroupPriceAdjust at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupPriceAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupPriceAdjust' text/json: schema: type: array items: $ref: '#/components/schemas/GroupPriceAdjust' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupPriceAdjust' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /groups: post: tags: - Groups summary: Create Groups description: Creates a new Groups operationId: CreateGroups parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Groups' text/json: schema: $ref: '#/components/schemas/Groups' application/*+json: schema: $ref: '#/components/schemas/Groups' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupsVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupsVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Groups summary: List Groups description: Lists all Groups operationId: ListGroups parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupsListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupsListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupsListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}': get: tags: - Groups summary: Get Groups description: Gets Groups operationId: GetGroups parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupsVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupsVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Groups summary: Update Groups description: Updates a specific Groups. operationId: UpdateGroups parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Groups' text/json: schema: $ref: '#/components/schemas/Groups' application/*+json: schema: $ref: '#/components/schemas/Groups' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupsVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupsVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Groups summary: Delete Groups description: Deletes an Groups operationId: DeleteGroups parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /groups-batch: put: tags: - Groups summary: Create or Update Batch Groups description: 'Create or Update multiple Groups at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroups parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Groups' text/json: schema: type: array items: $ref: '#/components/schemas/Groups' application/*+json: schema: type: array items: $ref: '#/components/schemas/Groups' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/disenroll': post: tags: - Groups - Adv. Groups summary: Group Disenroll description: Disenrolls a Group and/or Division. A VBAProcess object is returned representing the process state. See VBAProcess area for more information. operationId: GroupDisenroll parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnrollmentDisenrollGroup' text/json: schema: $ref: '#/components/schemas/EnrollmentDisenrollGroup' application/*+json: schema: $ref: '#/components/schemas/EnrollmentDisenrollGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/groups/{groupID}/reenroll': post: tags: - Groups - Adv. Groups summary: Group Reenroll description: Re-enrolls a Group and/or Division. A VBAProcess object is returned representing the process state. See VBAProcess area for more information. operationId: GroupReenroll parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnrollmentReenroll' text/json: schema: $ref: '#/components/schemas/EnrollmentReenroll' application/*+json: schema: $ref: '#/components/schemas/EnrollmentReenroll' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/groups/{groupID}/enrollment-summary': get: tags: - Groups - Adv. Groups summary: Get Group enrollment summary information description: 'Gets Group enrollment summary for the given group id. ' operationId: GetGroupEnrollmentSummary parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_GroupEnrollmentSummaryVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_GroupEnrollmentSummaryVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_GroupEnrollmentSummaryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /groups/id-card-selection: get: tags: - Groups summary: Get Group ID Card Selections description: Gets Group ID Card Selections operationId: GetGroupIDCardSelections parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: query description: Group ID schema: type: string - name: divisionID in: query description: Division ID schema: type: string - name: planID in: query description: Plan ID schema: type: string - name: relationship in: query description: Relationship schema: type: string - name: asOfDate in: query description: As of Date required: true schema: type: string format: date-time - name: flexVendor in: query description: Flex Vendor schema: type: string - name: page in: query description: Page Index schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_GroupIDCardSelectionVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_GroupIDCardSelectionVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_GroupIDCardSelectionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-self-admins: post: tags: - Group Self Admin Settings summary: Create GroupSelfAdmin description: Creates a new GroupSelfAdmin operationId: CreateGroupSelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupSelfAdmin' text/json: schema: $ref: '#/components/schemas/GroupSelfAdmin' application/*+json: schema: $ref: '#/components/schemas/GroupSelfAdmin' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupSelfAdminVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupSelfAdminVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupSelfAdminVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Self Admin Settings summary: List GroupSelfAdmin description: Lists all GroupSelfAdmin operationId: ListGroupSelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupSelfAdminListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupSelfAdminListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupSelfAdminListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/group-self-admins/{groupSelfAdminKey}': get: tags: - Group Self Admin Settings summary: Get GroupSelfAdmin description: Gets GroupSelfAdmin operationId: GetGroupSelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupSelfAdminKey in: path description: GroupSelfAdmin Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupSelfAdminVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupSelfAdminVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupSelfAdminVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Self Admin Settings summary: Update GroupSelfAdmin description: Updates a specific GroupSelfAdmin. operationId: UpdateGroupSelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupSelfAdminKey in: path description: GroupSelfAdmin Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupSelfAdmin' text/json: schema: $ref: '#/components/schemas/GroupSelfAdmin' application/*+json: schema: $ref: '#/components/schemas/GroupSelfAdmin' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupSelfAdminVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupSelfAdminVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupSelfAdminVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Self Admin Settings summary: Delete GroupSelfAdmin description: Deletes an GroupSelfAdmin operationId: DeleteGroupSelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupSelfAdminKey in: path description: GroupSelfAdmin Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-self-admins-batch: put: tags: - Group Self Admin Settings summary: Create or Update Batch GroupSelfAdmin description: 'Create or Update multiple GroupSelfAdmin at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupSelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupSelfAdmin' text/json: schema: type: array items: $ref: '#/components/schemas/GroupSelfAdmin' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupSelfAdmin' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-participation-incentives: post: tags: - Group Participation Incentives summary: Create GroupsParticipationIncentive description: Creates a new GroupsParticipationIncentive operationId: CreateGroupsParticipationIncentive parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupsParticipationIncentive' text/json: schema: $ref: '#/components/schemas/GroupsParticipationIncentive' application/*+json: schema: $ref: '#/components/schemas/GroupsParticipationIncentive' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupsParticipationIncentiveVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupsParticipationIncentiveVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupsParticipationIncentiveVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Participation Incentives summary: List GroupsParticipationIncentive description: Lists all GroupsParticipationIncentive operationId: ListGroupsParticipationIncentive parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupsParticipationIncentiveListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupsParticipationIncentiveListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupsParticipationIncentiveListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/group-participation-incentives/{groupsParticipationIncentiveKey}': get: tags: - Group Participation Incentives summary: Get GroupsParticipationIncentive description: Gets GroupsParticipationIncentive operationId: GetGroupsParticipationIncentive parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupsParticipationIncentiveKey in: path description: GroupsParticipationIncentive Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupsParticipationIncentiveVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupsParticipationIncentiveVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupsParticipationIncentiveVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Participation Incentives summary: Update GroupsParticipationIncentive description: Updates a specific GroupsParticipationIncentive. operationId: UpdateGroupsParticipationIncentive parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupsParticipationIncentiveKey in: path description: GroupsParticipationIncentive Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupsParticipationIncentive' text/json: schema: $ref: '#/components/schemas/GroupsParticipationIncentive' application/*+json: schema: $ref: '#/components/schemas/GroupsParticipationIncentive' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupsParticipationIncentiveVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupsParticipationIncentiveVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupsParticipationIncentiveVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Participation Incentives summary: Delete GroupsParticipationIncentive description: Deletes an GroupsParticipationIncentive operationId: DeleteGroupsParticipationIncentive parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupsParticipationIncentiveKey in: path description: GroupsParticipationIncentive Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-participation-incentives-batch: put: tags: - Group Participation Incentives summary: Create or Update Batch GroupsParticipationIncentive description: 'Create or Update multiple GroupsParticipationIncentive at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupsParticipationIncentive parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupsParticipationIncentive' text/json: schema: type: array items: $ref: '#/components/schemas/GroupsParticipationIncentive' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupsParticipationIncentive' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /id-card-request-statuses: get: tags: - ID Card Request Statuses summary: List ID Card Request Statuses description: List ID Card Request Statuses operationId: ListIDCardRequestStatuses parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /id-card-record-statuses: get: tags: - ID Card Record Statuses summary: List ID Card Record Statuses description: List ID Card Record Statuses operationId: ListIDCardRecordStatuses parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /coverage-calculations: get: tags: - Group Coverage Calculations summary: List Coverage Calculations description: List of key/value pairs for Coverage Calculations operationId: ListCoverageCalculations parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /term-rules: get: tags: - Group Term Rules summary: List Term Rules description: List of key/value pairs for Term Rules operationId: ListTermRules parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /multiplier-options: get: tags: - Group Multiplier Options summary: List Multiplier Options description: List of key/value pairs for Multiplier Options operationId: ListMultiplierOptions parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /start-date-rules: get: tags: - Group Start Date Rules summary: Start Date Rules description: List of key/value pairs for Start Date Rules operationId: ListStartDateRules parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /calculate-interest-options: get: tags: - Group Calculate Interest Options summary: Calculate Interest Options description: List of key/value pairs for Calculate Interest Options operationId: ListCalculateInterestOptions parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /calculate-interest-network-options: get: tags: - Group Calculate Interest Network Options summary: Calculate Interest Network Options description: List of key/value pairs for Calculate Interest Network Options operationId: ListCalculateInterestNetworkOptions parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /end-coverage-age-types: get: tags: - Group End Coverage Age Types summary: End Coverage Age Types description: List of key/value pairs for End Coverage Age Types operationId: ListEndCoverageAgeTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /pay-through-day-options: get: tags: - Group Pay Through Day Options summary: Pay Through Day Options description: List of key/value pairs for Pay Through Day Options operationId: ListPayThroughDayOptions parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tax-day-limit-types: get: tags: - Group Tax Day Limit Types summary: Tax Day Limit Types description: List of key/value pairs for Tax Day Limit Types operationId: ListTaxDayLimitTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/Int32StaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /contract-network-types: get: tags: - Group Contract Network Types summary: Contract Network Types description: List of key/value pairs for Contract Network Types operationId: ListContractNetworkTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /invoice-levels: get: tags: - Invoice Levels summary: List Invoice Levels description: List of key/value pairs for Invoice Levels operationId: ListInvoiceLevels parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/student-ages': post: tags: - Group Student Age Settings summary: Create GroupStudentAge description: Creates a new GroupStudentAge operationId: CreateGroupStudentAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupStudentAge' text/json: schema: $ref: '#/components/schemas/GroupStudentAge' application/*+json: schema: $ref: '#/components/schemas/GroupStudentAge' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupStudentAgeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupStudentAgeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupStudentAgeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Student Age Settings summary: List GroupStudentAge description: Lists all GroupStudentAge for the given groupID operationId: ListGroupStudentAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupStudentAgeListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupStudentAgeListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupStudentAgeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/student-ages/{groupStudentAgeKey}': get: tags: - Group Student Age Settings summary: Get GroupStudentAge description: Gets GroupStudentAge operationId: GetGroupStudentAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupStudentAgeKey in: path description: GroupStudentAge Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupStudentAgeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupStudentAgeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupStudentAgeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Student Age Settings summary: Update GroupStudentAge description: Updates a specific GroupStudentAge. operationId: UpdateGroupStudentAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupStudentAgeKey in: path description: GroupStudentAge Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupStudentAge' text/json: schema: $ref: '#/components/schemas/GroupStudentAge' application/*+json: schema: $ref: '#/components/schemas/GroupStudentAge' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupStudentAgeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupStudentAgeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupStudentAgeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Student Age Settings summary: Delete GroupStudentAge description: Deletes an GroupStudentAge operationId: DeleteGroupStudentAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupStudentAgeKey in: path description: GroupStudentAge Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/student-ages-batch': put: tags: - Group Student Age Settings summary: Create or Update Batch GroupStudentAge description: 'Create or Update multiple GroupStudentAge at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupStudentAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupStudentAge' text/json: schema: type: array items: $ref: '#/components/schemas/GroupStudentAge' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupStudentAge' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/uc-percent-settings': post: tags: - Group UC Percent Settings summary: Create GroupUCPercent description: Creates a new GroupUCPercent operationId: CreateGroupUCPercent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupUCPercent' text/json: schema: $ref: '#/components/schemas/GroupUCPercent' application/*+json: schema: $ref: '#/components/schemas/GroupUCPercent' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupUCPercentVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupUCPercentVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupUCPercentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group UC Percent Settings summary: List GroupUCPercent description: Lists all GroupUCPercent for the given groupID operationId: ListGroupUCPercent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupUCPercentListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupUCPercentListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupUCPercentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/uc-percent-settings/{groupUCPercentKey}': get: tags: - Group UC Percent Settings summary: Get GroupUCPercent description: Gets GroupUCPercent operationId: GetGroupUCPercent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupUCPercentKey in: path description: GroupUCPercent Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupUCPercentVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupUCPercentVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupUCPercentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group UC Percent Settings summary: Update GroupUCPercent description: Updates a specific GroupUCPercent. operationId: UpdateGroupUCPercent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupUCPercentKey in: path description: GroupUCPercent Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupUCPercent' text/json: schema: $ref: '#/components/schemas/GroupUCPercent' application/*+json: schema: $ref: '#/components/schemas/GroupUCPercent' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupUCPercentVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupUCPercentVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupUCPercentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group UC Percent Settings summary: Delete GroupUCPercent description: Deletes an GroupUCPercent operationId: DeleteGroupUCPercent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupUCPercentKey in: path description: GroupUCPercent Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/uc-percent-settings-batch': put: tags: - Group UC Percent Settings summary: Create or Update Batch GroupUCPercent description: 'Create or Update multiple GroupUCPercent at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupUCPercent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupUCPercent' text/json: schema: type: array items: $ref: '#/components/schemas/GroupUCPercent' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupUCPercent' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /uc-percent-claim-types: post: tags: - Group UC Percent Claim Types summary: Create GroupUCPercentClaimType description: Creates a new GroupUCPercentClaimType operationId: CreateGroupUCPercentClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupUCPercentClaimType' text/json: schema: $ref: '#/components/schemas/GroupUCPercentClaimType' application/*+json: schema: $ref: '#/components/schemas/GroupUCPercentClaimType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupUCPercentClaimTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupUCPercentClaimTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupUCPercentClaimTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group UC Percent Claim Types summary: List GroupUCPercentClaimType description: Lists all GroupUCPercentClaimType operationId: ListGroupUCPercentClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupUCPercentClaimTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupUCPercentClaimTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupUCPercentClaimTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/uc-percent-claim-types/{uCPercentClaimType}': get: tags: - Group UC Percent Claim Types summary: Get GroupUCPercentClaimType description: Gets GroupUCPercentClaimType operationId: GetGroupUCPercentClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: uCPercentClaimType in: path description: UC Percent Claim Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupUCPercentClaimTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupUCPercentClaimTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupUCPercentClaimTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group UC Percent Claim Types summary: Update GroupUCPercentClaimType description: Updates a specific GroupUCPercentClaimType. operationId: UpdateGroupUCPercentClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: uCPercentClaimType in: path description: UC Percent Claim Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupUCPercentClaimType' text/json: schema: $ref: '#/components/schemas/GroupUCPercentClaimType' application/*+json: schema: $ref: '#/components/schemas/GroupUCPercentClaimType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupUCPercentClaimTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupUCPercentClaimTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupUCPercentClaimTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group UC Percent Claim Types summary: Delete GroupUCPercentClaimType description: Deletes an GroupUCPercentClaimType operationId: DeleteGroupUCPercentClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: uCPercentClaimType in: path description: UC Percent Claim Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /uc-percent-claim-types-batch: put: tags: - Group UC Percent Claim Types summary: Create or Update Batch GroupUCPercentClaimType description: 'Create or Update multiple GroupUCPercentClaimType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupUCPercentClaimType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupUCPercentClaimType' text/json: schema: type: array items: $ref: '#/components/schemas/GroupUCPercentClaimType' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupUCPercentClaimType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-uc-percent-criterias: post: tags: - Group UC Percent Criterias summary: Create GroupUCPercentCriteria description: Creates a new GroupUCPercentCriteria operationId: CreateGroupUCPercentCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupUCPercentCriteria' text/json: schema: $ref: '#/components/schemas/GroupUCPercentCriteria' application/*+json: schema: $ref: '#/components/schemas/GroupUCPercentCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupUCPercentCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupUCPercentCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupUCPercentCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group UC Percent Criterias summary: List GroupUCPercentCriteria description: Lists all GroupUCPercentCriteria operationId: ListGroupUCPercentCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupUCPercentCriteriaListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupUCPercentCriteriaListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupUCPercentCriteriaListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/group-uc-percent-criterias/{GroupUCPercentCriteria_Key}': get: tags: - Group UC Percent Criterias summary: Get GroupUCPercentCriteria description: Gets GroupUCPercentCriteria operationId: GetGroupUCPercentCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: GroupUCPercentCriteria_Key in: path description: GroupUCPercentCriteria Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupUCPercentCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupUCPercentCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupUCPercentCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group UC Percent Criterias summary: Update GroupUCPercentCriteria description: Updates a specific GroupUCPercentCriteria. operationId: UpdateGroupUCPercentCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: GroupUCPercentCriteria_Key in: path description: GroupUCPercentCriteria Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupUCPercentCriteria' text/json: schema: $ref: '#/components/schemas/GroupUCPercentCriteria' application/*+json: schema: $ref: '#/components/schemas/GroupUCPercentCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupUCPercentCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupUCPercentCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupUCPercentCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group UC Percent Criterias summary: Delete GroupUCPercentCriteria description: Deletes an GroupUCPercentCriteria operationId: DeleteGroupUCPercentCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: GroupUCPercentCriteria_Key in: path description: GroupUCPercentCriteria Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /group-uc-percent-criterias-batch: put: tags: - Group UC Percent Criterias summary: Create or Update Batch GroupUCPercentCriteria description: 'Create or Update multiple GroupUCPercentCriteria at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupUCPercentCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupUCPercentCriteria' text/json: schema: type: array items: $ref: '#/components/schemas/GroupUCPercentCriteria' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupUCPercentCriteria' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/vba-plan-types': post: tags: - Group VBA Plan Types summary: Create GroupVBAPlanTypeSubscriberID description: Creates a new GroupVBAPlanTypeSubscriberID operationId: CreateGroupVBAPlanTypeSubscriberID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberID' text/json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberID' application/*+json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberID' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberIDVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberIDVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberIDVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group VBA Plan Types summary: List GroupVBAPlanTypeSubscriberID description: Lists all GroupVBAPlanTypeSubscriberID for the given groupID operationId: ListGroupVBAPlanTypeSubscriberID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberIDListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberIDListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberIDListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/vba-plan-types/{groupVBAPlanTypeSubscriberIDKey}': get: tags: - Group VBA Plan Types summary: Get GroupVBAPlanTypeSubscriberID description: Gets GroupVBAPlanTypeSubscriberID operationId: GetGroupVBAPlanTypeSubscriberID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupVBAPlanTypeSubscriberIDKey in: path description: GroupVBAPlanTypeSubscriberID Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberIDVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberIDVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberIDVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group VBA Plan Types summary: Update GroupVBAPlanTypeSubscriberID description: Updates a specific GroupVBAPlanTypeSubscriberID. operationId: UpdateGroupVBAPlanTypeSubscriberID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupVBAPlanTypeSubscriberIDKey in: path description: GroupVBAPlanTypeSubscriberID Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberID' text/json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberID' application/*+json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberID' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberIDVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberIDVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberIDVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group VBA Plan Types summary: Delete GroupVBAPlanTypeSubscriberID description: Deletes an GroupVBAPlanTypeSubscriberID operationId: DeleteGroupVBAPlanTypeSubscriberID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupVBAPlanTypeSubscriberIDKey in: path description: GroupVBAPlanTypeSubscriberID Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/vba-plan-types-batch': put: tags: - Group VBA Plan Types summary: Create or Update Batch GroupVBAPlanTypeSubscriberID description: 'Create or Update multiple GroupVBAPlanTypeSubscriberID at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupVBAPlanTypeSubscriberID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberID' text/json: schema: type: array items: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberID' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberID' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/volumes': post: tags: - Group Volumes summary: Create GroupVolume description: Creates a new GroupVolume operationId: CreateGroupVolume parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupVolume' text/json: schema: $ref: '#/components/schemas/GroupVolume' application/*+json: schema: $ref: '#/components/schemas/GroupVolume' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupVolumeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupVolumeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupVolumeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Volumes summary: List GroupVolume description: Lists all GroupVolume for the given groupID operationId: ListGroupVolume parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupVolumeListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupVolumeListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupVolumeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /groups-volumes-nested: get: tags: - Group Volumes summary: List GroupVolume nested by Division/Plan/Benefit description: 'Lists all GroupVolume for the given groupID and have it nested by Division, then by Plan, then by Benefit.' operationId: ListGroupVolumeNested parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: query description: Group ID schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupVolumeNestedListVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupVolumeNestedListVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupVolumeNestedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/volumes/{groupVolumeKey}': get: tags: - Group Volumes summary: Get GroupVolume description: Gets GroupVolume operationId: GetGroupVolume parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupVolumeKey in: path description: GroupVolume Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupVolumeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupVolumeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupVolumeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Volumes summary: Update GroupVolume description: Updates a specific GroupVolume. operationId: UpdateGroupVolume parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupVolumeKey in: path description: GroupVolume Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupVolume' text/json: schema: $ref: '#/components/schemas/GroupVolume' application/*+json: schema: $ref: '#/components/schemas/GroupVolume' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupVolumeVBAResponse' application/json: schema: $ref: '#/components/schemas/GroupVolumeVBAResponse' text/json: schema: $ref: '#/components/schemas/GroupVolumeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Volumes summary: Delete GroupVolume description: Deletes an GroupVolume operationId: DeleteGroupVolume parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: groupVolumeKey in: path description: GroupVolume Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/volumes-batch': put: tags: - Group Volumes summary: Create or Update Batch GroupVolume description: 'Create or Update multiple GroupVolume at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchGroupVolume parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupVolume' text/json: schema: type: array items: $ref: '#/components/schemas/GroupVolume' application/*+json: schema: type: array items: $ref: '#/components/schemas/GroupVolume' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-adjustment-codes: post: tags: - HIPAA Adjustment Codes summary: Create HIPAAAdjustmentCode description: Creates a new HIPAAAdjustmentCode operationId: CreateHIPAAAdjustmentCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCode' text/json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCode' application/*+json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAAdjustmentCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - HIPAA Adjustment Codes summary: List HIPAAAdjustmentCode description: 'Lists all HIPAAAdjustmentCode given a specific ' operationId: ListHIPAAAdjustmentCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAAdjustmentCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/hipaa-adjustment-codes/{hIPAACode}': get: tags: - HIPAA Adjustment Codes summary: Get HIPAAAdjustmentCode description: Gets HIPAAAdjustmentCode operationId: GetHIPAAAdjustmentCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAAdjustmentCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - HIPAA Adjustment Codes summary: Update HIPAAAdjustmentCode description: Updates a specific HIPAAAdjustmentCode. operationId: UpdateHIPAAAdjustmentCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCode' text/json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCode' application/*+json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAAdjustmentCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAAdjustmentCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - HIPAA Adjustment Codes summary: Delete HIPAAAdjustmentCode description: Deletes an HIPAAAdjustmentCode operationId: DeleteHIPAAAdjustmentCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-adjustment-codes-batch: put: tags: - HIPAA Adjustment Codes summary: Create or Update Batch HIPAAAdjustmentCode description: 'Create or Update multiple HIPAAAdjustmentCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchHIPAAAdjustmentCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/HIPAAAdjustmentCode' text/json: schema: type: array items: $ref: '#/components/schemas/HIPAAAdjustmentCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/HIPAAAdjustmentCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-benefit-codes: post: tags: - HIPAA Benefit Codes summary: Create HIPAABenefitCode description: Creates a new HIPAABenefitCode operationId: CreateHIPAABenefitCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAABenefitCode' text/json: schema: $ref: '#/components/schemas/HIPAABenefitCode' application/*+json: schema: $ref: '#/components/schemas/HIPAABenefitCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAABenefitCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAABenefitCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAABenefitCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - HIPAA Benefit Codes summary: List HIPAABenefitCode description: 'Lists all HIPAABenefitCode given a specific ' operationId: ListHIPAABenefitCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAABenefitCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAABenefitCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAABenefitCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/hipaa-benefit-codes/{hIPAACode}': get: tags: - HIPAA Benefit Codes summary: Get HIPAABenefitCode description: Gets HIPAABenefitCode operationId: GetHIPAABenefitCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAABenefitCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAABenefitCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAABenefitCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - HIPAA Benefit Codes summary: Update HIPAABenefitCode description: Updates a specific HIPAABenefitCode. operationId: UpdateHIPAABenefitCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAABenefitCode' text/json: schema: $ref: '#/components/schemas/HIPAABenefitCode' application/*+json: schema: $ref: '#/components/schemas/HIPAABenefitCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAABenefitCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAABenefitCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAABenefitCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - HIPAA Benefit Codes summary: Delete HIPAABenefitCode description: Deletes an HIPAABenefitCode operationId: DeleteHIPAABenefitCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-benefit-codes-batch: put: tags: - HIPAA Benefit Codes summary: Create or Update Batch HIPAABenefitCode description: 'Create or Update multiple HIPAABenefitCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchHIPAABenefitCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/HIPAABenefitCode' text/json: schema: type: array items: $ref: '#/components/schemas/HIPAABenefitCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/HIPAABenefitCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-claim-status-category-codes: post: tags: - HIPAA Claim Status Category Codes summary: Create HIPAAClaimStatusCategoryCode description: Creates a new HIPAAClaimStatusCategoryCode operationId: CreateHIPAAClaimStatusCategoryCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCode' text/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCode' application/*+json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - HIPAA Claim Status Category Codes summary: List HIPAAClaimStatusCategoryCode description: 'Lists all HIPAAClaimStatusCategoryCode given a specific ' operationId: ListHIPAAClaimStatusCategoryCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/hipaa-claim-status-category-codes/{hIPAACode}': get: tags: - HIPAA Claim Status Category Codes summary: Get HIPAAClaimStatusCategoryCode description: Gets HIPAAClaimStatusCategoryCode operationId: GetHIPAAClaimStatusCategoryCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - HIPAA Claim Status Category Codes summary: Update HIPAAClaimStatusCategoryCode description: Updates a specific HIPAAClaimStatusCategoryCode. operationId: UpdateHIPAAClaimStatusCategoryCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCode' text/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCode' application/*+json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - HIPAA Claim Status Category Codes summary: Delete HIPAAClaimStatusCategoryCode description: Deletes an HIPAAClaimStatusCategoryCode operationId: DeleteHIPAAClaimStatusCategoryCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-claim-status-category-codes-batch: put: tags: - HIPAA Claim Status Category Codes summary: Create or Update Batch HIPAAClaimStatusCategoryCode description: 'Create or Update multiple HIPAAClaimStatusCategoryCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchHIPAAClaimStatusCategoryCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCode' text/json: schema: type: array items: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-claim-status-codes: post: tags: - HIPAA Claim Status Codes summary: Create HIPAAClaimStatusCode description: Creates a new HIPAAClaimStatusCode operationId: CreateHIPAAClaimStatusCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCode' text/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCode' application/*+json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAClaimStatusCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - HIPAA Claim Status Codes summary: List HIPAAClaimStatusCode description: 'Lists all HIPAAClaimStatusCode given a specific ' operationId: ListHIPAAClaimStatusCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAClaimStatusCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/hipaa-claim-status-codes/{hIPAACode}': get: tags: - HIPAA Claim Status Codes summary: Get HIPAAClaimStatusCode description: Gets HIPAAClaimStatusCode operationId: GetHIPAAClaimStatusCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAClaimStatusCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - HIPAA Claim Status Codes summary: Update HIPAAClaimStatusCode description: Updates a specific HIPAAClaimStatusCode. operationId: UpdateHIPAAClaimStatusCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCode' text/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCode' application/*+json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAClaimStatusCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAClaimStatusCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - HIPAA Claim Status Codes summary: Delete HIPAAClaimStatusCode description: Deletes an HIPAAClaimStatusCode operationId: DeleteHIPAAClaimStatusCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-claim-status-codes-batch: put: tags: - HIPAA Claim Status Codes summary: Create or Update Batch HIPAAClaimStatusCode description: 'Create or Update multiple HIPAAClaimStatusCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchHIPAAClaimStatusCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/HIPAAClaimStatusCode' text/json: schema: type: array items: $ref: '#/components/schemas/HIPAAClaimStatusCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/HIPAAClaimStatusCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-plan-types: post: tags: - HIPAA Plan Types summary: Create HIPAAPlanType description: Creates a new HIPAAPlanType operationId: CreateHIPAAPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAAPlanType' text/json: schema: $ref: '#/components/schemas/HIPAAPlanType' application/*+json: schema: $ref: '#/components/schemas/HIPAAPlanType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAPlanTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAPlanTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAPlanTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - HIPAA Plan Types summary: List HIPAAPlanType description: 'Lists all HIPAAPlanType given a specific ' operationId: ListHIPAAPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAPlanTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAPlanTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAPlanTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/hipaa-plan-types/{hIPAACode}': get: tags: - HIPAA Plan Types summary: Get HIPAAPlanType description: Gets HIPAAPlanType operationId: GetHIPAAPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAPlanTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAPlanTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAPlanTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - HIPAA Plan Types summary: Update HIPAAPlanType description: Updates a specific HIPAAPlanType. operationId: UpdateHIPAAPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAAPlanType' text/json: schema: $ref: '#/components/schemas/HIPAAPlanType' application/*+json: schema: $ref: '#/components/schemas/HIPAAPlanType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAPlanTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAPlanTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAPlanTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - HIPAA Plan Types summary: Delete HIPAAPlanType description: Deletes an HIPAAPlanType operationId: DeleteHIPAAPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-plan-types-batch: put: tags: - HIPAA Plan Types summary: Create or Update Batch HIPAAPlanType description: 'Create or Update multiple HIPAAPlanType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchHIPAAPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/HIPAAPlanType' text/json: schema: type: array items: $ref: '#/components/schemas/HIPAAPlanType' application/*+json: schema: type: array items: $ref: '#/components/schemas/HIPAAPlanType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-reasons: post: tags: - HIPAA Reasons summary: Create HIPAAReason description: Creates a new HIPAAReason operationId: CreateHIPAAReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAAReason' text/json: schema: $ref: '#/components/schemas/HIPAAReason' application/*+json: schema: $ref: '#/components/schemas/HIPAAReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - HIPAA Reasons summary: List HIPAAReason description: 'Lists all HIPAAReason given a specific ' operationId: ListHIPAAReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAReasonListVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAReasonListVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAReasonListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/hipaa-reasons/{hIPAACode}': get: tags: - HIPAA Reasons summary: Get HIPAAReason description: Gets HIPAAReason operationId: GetHIPAAReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - HIPAA Reasons summary: Update HIPAAReason description: Updates a specific HIPAAReason. operationId: UpdateHIPAAReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAAReason' text/json: schema: $ref: '#/components/schemas/HIPAAReason' application/*+json: schema: $ref: '#/components/schemas/HIPAAReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAAReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAAReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAAReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - HIPAA Reasons summary: Delete HIPAAReason description: Deletes an HIPAAReason operationId: DeleteHIPAAReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-reasons-batch: put: tags: - HIPAA Reasons summary: Create or Update Batch HIPAAReason description: 'Create or Update multiple HIPAAReason at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchHIPAAReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/HIPAAReason' text/json: schema: type: array items: $ref: '#/components/schemas/HIPAAReason' application/*+json: schema: type: array items: $ref: '#/components/schemas/HIPAAReason' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-relationships: post: tags: - HIPAA Relationships summary: Create HIPAARelationship description: Creates a new HIPAARelationship operationId: CreateHIPAARelationship parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAARelationship' text/json: schema: $ref: '#/components/schemas/HIPAARelationship' application/*+json: schema: $ref: '#/components/schemas/HIPAARelationship' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAARelationshipVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAARelationshipVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAARelationshipVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - HIPAA Relationships summary: List HIPAARelationship description: 'Lists all HIPAARelationship given a specific ' operationId: ListHIPAARelationship parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAARelationshipListVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAARelationshipListVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAARelationshipListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/hipaa-relationships/{hIPAACode}': get: tags: - HIPAA Relationships summary: Get HIPAARelationship description: Gets HIPAARelationship operationId: GetHIPAARelationship parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAARelationshipVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAARelationshipVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAARelationshipVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - HIPAA Relationships summary: Update HIPAARelationship description: Updates a specific HIPAARelationship. operationId: UpdateHIPAARelationship parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAARelationship' text/json: schema: $ref: '#/components/schemas/HIPAARelationship' application/*+json: schema: $ref: '#/components/schemas/HIPAARelationship' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAARelationshipVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAARelationshipVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAARelationshipVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - HIPAA Relationships summary: Delete HIPAARelationship description: Deletes an HIPAARelationship operationId: DeleteHIPAARelationship parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-relationships-batch: put: tags: - HIPAA Relationships summary: Create or Update Batch HIPAARelationship description: 'Create or Update multiple HIPAARelationship at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchHIPAARelationship parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/HIPAARelationship' text/json: schema: type: array items: $ref: '#/components/schemas/HIPAARelationship' application/*+json: schema: type: array items: $ref: '#/components/schemas/HIPAARelationship' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-tiers: post: tags: - HIPAA Tiers summary: Create HIPAATier description: Creates a new HIPAATier operationId: CreateHIPAATier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAATier' text/json: schema: $ref: '#/components/schemas/HIPAATier' application/*+json: schema: $ref: '#/components/schemas/HIPAATier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAATierVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAATierVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAATierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - HIPAA Tiers summary: List HIPAATier description: 'Lists all HIPAATier given a specific ' operationId: ListHIPAATier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAATierListVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAATierListVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAATierListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/hipaa-tiers/{hIPAACode}': get: tags: - HIPAA Tiers summary: Get HIPAATier description: Gets HIPAATier operationId: GetHIPAATier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAATierVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAATierVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAATierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - HIPAA Tiers summary: Update HIPAATier description: Updates a specific HIPAATier. operationId: UpdateHIPAATier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HIPAATier' text/json: schema: $ref: '#/components/schemas/HIPAATier' application/*+json: schema: $ref: '#/components/schemas/HIPAATier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/HIPAATierVBAResponse' application/json: schema: $ref: '#/components/schemas/HIPAATierVBAResponse' text/json: schema: $ref: '#/components/schemas/HIPAATierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - HIPAA Tiers summary: Delete HIPAATier description: Deletes an HIPAATier operationId: DeleteHIPAATier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: hIPAACode in: path description: HIPAA Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /hipaa-tiers-batch: put: tags: - HIPAA Tiers summary: Create or Update Batch HIPAATier description: 'Create or Update multiple HIPAATier at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchHIPAATier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/HIPAATier' text/json: schema: type: array items: $ref: '#/components/schemas/HIPAATier' application/*+json: schema: type: array items: $ref: '#/components/schemas/HIPAATier' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /id-card-requests: post: tags: - Member ID Card Requests summary: Create IDCardRequest description: Creates a new IDCardRequest operationId: CreateIDCardRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IDCardRequest' text/json: schema: $ref: '#/components/schemas/IDCardRequest' application/*+json: schema: $ref: '#/components/schemas/IDCardRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCardRequestVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCardRequestVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCardRequestVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member ID Card Requests summary: List IDCardRequest description: Lists all IDCardRequest operationId: ListIDCardRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCardRequestListVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCardRequestListVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCardRequestListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/id-card-requests/{iDCardRequestKey}': get: tags: - Member ID Card Requests summary: Get IDCardRequest description: Gets IDCardRequest operationId: GetIDCardRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: iDCardRequestKey in: path description: IDCardRequest Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCardRequestVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCardRequestVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCardRequestVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member ID Card Requests summary: Update IDCardRequest description: Updates a specific IDCardRequest. operationId: UpdateIDCardRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: iDCardRequestKey in: path description: IDCardRequest Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/IDCardRequest' text/json: schema: $ref: '#/components/schemas/IDCardRequest' application/*+json: schema: $ref: '#/components/schemas/IDCardRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCardRequestVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCardRequestVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCardRequestVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member ID Card Requests summary: Delete IDCardRequest description: Deletes an IDCardRequest operationId: DeleteIDCardRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: iDCardRequestKey in: path description: IDCardRequest Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /id-card-requests-batch: put: tags: - Member ID Card Requests summary: Create or Update Batch IDCardRequest description: 'Create or Update multiple IDCardRequest at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchIDCardRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IDCardRequest' text/json: schema: type: array items: $ref: '#/components/schemas/IDCardRequest' application/*+json: schema: type: array items: $ref: '#/components/schemas/IDCardRequest' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /id-card-request-types: post: tags: - Member ID Card Request Types summary: Create IDCardRequestType description: Creates a new IDCardRequestType operationId: CreateIDCardRequestType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IDCardRequestType' text/json: schema: $ref: '#/components/schemas/IDCardRequestType' application/*+json: schema: $ref: '#/components/schemas/IDCardRequestType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCardRequestTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCardRequestTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCardRequestTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member ID Card Request Types summary: List IDCardRequestType description: Lists all IDCardRequestType operationId: ListIDCardRequestType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCardRequestTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCardRequestTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCardRequestTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/id-card-request-types/{requestType}': get: tags: - Member ID Card Request Types summary: Get IDCardRequestType description: Gets IDCardRequestType operationId: GetIDCardRequestType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestType in: path description: Request Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCardRequestTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCardRequestTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCardRequestTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member ID Card Request Types summary: Update IDCardRequestType description: Updates a specific IDCardRequestType. operationId: UpdateIDCardRequestType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestType in: path description: Request Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IDCardRequestType' text/json: schema: $ref: '#/components/schemas/IDCardRequestType' application/*+json: schema: $ref: '#/components/schemas/IDCardRequestType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCardRequestTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCardRequestTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCardRequestTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member ID Card Request Types summary: Delete IDCardRequestType description: Deletes an IDCardRequestType operationId: DeleteIDCardRequestType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: requestType in: path description: Request Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /id-card-request-types-batch: put: tags: - Member ID Card Request Types summary: Create or Update Batch IDCardRequestType description: 'Create or Update multiple IDCardRequestType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchIDCardRequestType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IDCardRequestType' text/json: schema: type: array items: $ref: '#/components/schemas/IDCardRequestType' application/*+json: schema: type: array items: $ref: '#/components/schemas/IDCardRequestType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/id-types/{type}/id-codes': post: tags: - ID Code Types summary: Create IDCodeType description: Creates a new IDCodeType operationId: CreateIDCodeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IDCodeType' text/json: schema: $ref: '#/components/schemas/IDCodeType' application/*+json: schema: $ref: '#/components/schemas/IDCodeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCodeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCodeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCodeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - ID Code Types summary: List IDCodeType description: Lists all IDCodeType for the given type operationId: ListIDCodeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCodeTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCodeTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCodeTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/id-types/{type}/id-codes/{idCode}': get: tags: - ID Code Types summary: Get IDCodeType description: Gets IDCodeType operationId: GetIDCodeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string - name: idCode in: path description: ID Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCodeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCodeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCodeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - ID Code Types summary: Update IDCodeType description: Updates a specific IDCodeType. operationId: UpdateIDCodeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string - name: idCode in: path description: ID Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IDCodeType' text/json: schema: $ref: '#/components/schemas/IDCodeType' application/*+json: schema: $ref: '#/components/schemas/IDCodeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCodeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCodeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCodeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - ID Code Types summary: Delete IDCodeType description: Deletes an IDCodeType operationId: DeleteIDCodeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string - name: idCode in: path description: ID Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/id-types/{type}/id-codes-batch': put: tags: - ID Code Types summary: Create or Update Batch IDCodeType description: 'Create or Update multiple IDCodeType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchIDCodeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IDCodeType' text/json: schema: type: array items: $ref: '#/components/schemas/IDCodeType' application/*+json: schema: type: array items: $ref: '#/components/schemas/IDCodeType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/id-types/{type}/id-codes/{idCode}/id-code-values': post: tags: - ID Code Values summary: Create IDCodeValue description: Creates a new IDCodeValue operationId: CreateIDCodeValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string - name: idCode in: path description: ID Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IDCodeValue' text/json: schema: $ref: '#/components/schemas/IDCodeValue' application/*+json: schema: $ref: '#/components/schemas/IDCodeValue' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCodeValueVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCodeValueVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCodeValueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - ID Code Values summary: List IDCodeValue description: Lists all IDCodeValue for the given type and idCode operationId: ListIDCodeValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string - name: idCode in: path description: ID Code required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCodeValueListVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCodeValueListVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCodeValueListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /id-code-values-by-source: get: tags: - ID Code Values summary: List IDCodeValue based on Source description: "Lists all IDCodeValue for the given type and specific source\r\n\t Based on IDCodeType we will return different values.\r\n\r\n\t AUTH\r\n\t\t @SourceColumn1 = auth_number\r\n\r\n\t BENEFIT\r\n\t\t @SourceColumn1 = benefit_code\r\n\r\n\t CAREPLAN\r\n\t\t @SourceColumn1 = case_key\r\n\r\n\t CARRIER\r\n\t\t @SourceColumn1 = carrier_key\r\n\r\n\t CASE\r\n\t\t @SourceColumn1 = case_key\r\n\r\n\t CLAIM\r\n\t\t @SourceColumn1 = batch_number\r\n\t\t @SourceColumn2 = batch_claim\r\n\r\n\t CLMBTCH\r\n\t\t @SourceColumn1 = batch_number\r\n\r\n\t COMMAGENCY\r\n\t\t @SourceColumn1 = commissionagency_key\r\n\r\n\t COMMREP\r\n\t\t @SourceColumn1 = commissionrep_key\r\n\r\n\t COMPANYDATA\r\n\t\t @SourceColumn1 = key_value\r\n\r\n\t CONTRACTRIDER\r\n\t\t @SourceColumn1 = group_id\r\n\t\t @SourceColumn2 = division_id\r\n\t\t @SourceColumn3 = coverage_start\r\n\t\t @SourceColumn4 = plan_id\r\n\t\t @SourceColumn5 = benefit_code\r\n\r\n\t CREDQUESTION\r\n\t\t @SourceColumn1 = credattestationquestion_key\r\n\r\n\t DISREASON\r\n\t\t @SourceColumn1 = reason_id\r\n\r\n\t FUNDINGACCOUNT\r\n\t\t @SourceColumn1 = account_key\r\n\r\n\t GRIEV\r\n\t\t @SourceColumn1 = grievance_key\r\n\r\n\t GROUP\r\n\t\t @SourceColumn1 = group_id\r\n\r\n\t GROUPDIVISION\r\n\t\t @SourceColumn1 = group_id\r\n\t\t @SourceColumn1 = division_id\r\n\r\n\t GROUPNETWORK\r\n\t\t @SourceColumn1 = group_id\r\n\t\t @SourceColumn2 = division_id\r\n\t\t @SourceColumn3 = coverage_start\r\n\t\t @SourceColumn4 = networkid\r\n\r\n\t GROUPPLAN\r\n\t\t @SourceColumn1 = group_id\r\n\t\t @SourceColumn2 = division_id\r\n\t\t @SourceColumn3 = plan_id\r\n\r\n\t INTRFACE\r\n\t\t @SourceColumn1 = vbainterface_key\r\n\r\n\t MEMBER\r\n\t\t @SourceColumn1 = subscriber_id\r\n\t\t @SourceColumn2 = member_seq\r\n\r\n\t NETWORK\r\n\t\t @SourceColumn1 = networkid\r\n\r\n\t PAYEE\r\n\t\t @SourceColumn1 = payee_id\r\n\r\n\t PAYOR\r\n\t\t @SourceColumn1 = payor_id\r\n\r\n\t PLAN\r\n\t\t @SourceColumn1 = plan_id\r\n\r\n\t PROV\r\n\t\t @SourceColumn1 = provider_id\r\n\r\n\t PROVCRED\r\n\t\t @SourceColumn1 = providercred_key\r\n\r\n\t REINS\r\n\t\t @SourceColumn1 = reinscontract_key\r\n\r\n\t SUBSCRIBER\r\n\t\t @SourceColumn1 = subscriber_id\r\n\r\n\t USER\r\n\t\t @SourceColumn1 = user_id\r\n " operationId: ListIDCodeValueBySource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: query description: Type required: true schema: type: string - name: columnName1 in: query description: Column_Name1 required: true schema: type: string - name: keyValue1 in: query description: Key_Value1 required: true schema: type: string - name: columnName2 in: query description: Column_Name2 schema: type: string - name: keyValue2 in: query description: Key_Value2 schema: type: string - name: columnName3 in: query description: Column_Name3 schema: type: string - name: keyValue3 in: query description: Key_Value3 schema: type: string - name: columnName4 in: query description: Column_Name4 schema: type: string - name: keyValue4 in: query description: Key_Value4 schema: type: string - name: columnName5 in: query description: Column_Name5 schema: type: string - name: keyValue5 in: query description: Key_Value5 schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCodeValue_ResultBySourceListVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCodeValue_ResultBySourceListVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCodeValue_ResultBySourceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/id-types/{type}/id-codes/{idCode}/id-code-values/{idCodeValueKey}': get: tags: - ID Code Values summary: Get IDCodeValue description: Gets IDCodeValue operationId: GetIDCodeValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string - name: idCode in: path description: ID Code required: true schema: type: string - name: idCodeValueKey in: path description: IDCodeValue Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCodeValueVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCodeValueVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCodeValueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - ID Code Values summary: Update IDCodeValue description: Updates a specific IDCodeValue. operationId: UpdateIDCodeValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string - name: idCode in: path description: ID Code required: true schema: type: string - name: idCodeValueKey in: path description: IDCodeValue Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/IDCodeValue' text/json: schema: $ref: '#/components/schemas/IDCodeValue' application/*+json: schema: $ref: '#/components/schemas/IDCodeValue' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDCodeValueVBAResponse' application/json: schema: $ref: '#/components/schemas/IDCodeValueVBAResponse' text/json: schema: $ref: '#/components/schemas/IDCodeValueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - ID Code Values summary: Delete IDCodeValue description: Deletes an IDCodeValue operationId: DeleteIDCodeValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string - name: idCode in: path description: ID Code required: true schema: type: string - name: idCodeValueKey in: path description: IDCodeValue Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/id-types/{type}/id-codes/{idCode}/id-code-values-batch': put: tags: - ID Code Values summary: Create or Update Batch IDCodeValue description: 'Create or Update multiple IDCodeValue at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchIDCodeValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string - name: idCode in: path description: ID Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IDCodeValue' text/json: schema: type: array items: $ref: '#/components/schemas/IDCodeValue' application/*+json: schema: type: array items: $ref: '#/components/schemas/IDCodeValue' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /id-types: post: tags: - ID Types summary: Create IDType description: Creates a new IDType operationId: CreateIDType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IDType' text/json: schema: $ref: '#/components/schemas/IDType' application/*+json: schema: $ref: '#/components/schemas/IDType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/IDTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/IDTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - ID Types summary: List IDType description: Lists all IDType operationId: ListIDType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/IDTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/IDTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - ID Types summary: Create or Update Batch IDType description: 'Create or Update multiple IDType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchIDType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IDType' text/json: schema: type: array items: $ref: '#/components/schemas/IDType' application/*+json: schema: type: array items: $ref: '#/components/schemas/IDType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/id-types/{type}': get: tags: - ID Types summary: Get IDType description: Gets IDType operationId: GetIDType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/IDTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/IDTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - ID Types summary: Update IDType description: Updates a specific IDType. operationId: UpdateIDType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IDType' text/json: schema: $ref: '#/components/schemas/IDType' application/*+json: schema: $ref: '#/components/schemas/IDType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IDTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/IDTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/IDTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - ID Types summary: Delete IDType description: Deletes an IDType operationId: DeleteIDType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: type in: path description: Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /insurance-carriers: post: tags: - Insurance Carriers summary: Create InsuranceCarrier description: Creates a new InsuranceCarrier operationId: CreateInsuranceCarrier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/InsuranceCarrier' text/json: schema: $ref: '#/components/schemas/InsuranceCarrier' application/*+json: schema: $ref: '#/components/schemas/InsuranceCarrier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InsuranceCarrierVBAResponse' application/json: schema: $ref: '#/components/schemas/InsuranceCarrierVBAResponse' text/json: schema: $ref: '#/components/schemas/InsuranceCarrierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Insurance Carriers summary: List InsuranceCarrier description: Lists all InsuranceCarrier operationId: ListInsuranceCarrier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InsuranceCarrierListVBAResponse' application/json: schema: $ref: '#/components/schemas/InsuranceCarrierListVBAResponse' text/json: schema: $ref: '#/components/schemas/InsuranceCarrierListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/insurance-carriers/{carrierKey}': get: tags: - Insurance Carriers summary: Get InsuranceCarrier description: Gets InsuranceCarrier operationId: GetInsuranceCarrier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carrierKey in: path description: Carrier Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InsuranceCarrierVBAResponse' application/json: schema: $ref: '#/components/schemas/InsuranceCarrierVBAResponse' text/json: schema: $ref: '#/components/schemas/InsuranceCarrierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Insurance Carriers summary: Update InsuranceCarrier description: Updates a specific InsuranceCarrier. operationId: UpdateInsuranceCarrier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carrierKey in: path description: Carrier Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/InsuranceCarrier' text/json: schema: $ref: '#/components/schemas/InsuranceCarrier' application/*+json: schema: $ref: '#/components/schemas/InsuranceCarrier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InsuranceCarrierVBAResponse' application/json: schema: $ref: '#/components/schemas/InsuranceCarrierVBAResponse' text/json: schema: $ref: '#/components/schemas/InsuranceCarrierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Insurance Carriers summary: Delete InsuranceCarrier description: Deletes an InsuranceCarrier operationId: DeleteInsuranceCarrier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carrierKey in: path description: Carrier Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /insurance-carriers-batch: put: tags: - Insurance Carriers summary: Create or Update Batch InsuranceCarrier description: 'Create or Update multiple InsuranceCarrier at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchInsuranceCarrier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InsuranceCarrier' text/json: schema: type: array items: $ref: '#/components/schemas/InsuranceCarrier' application/*+json: schema: type: array items: $ref: '#/components/schemas/InsuranceCarrier' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /insurance-carrier-types: post: tags: - Insurance Carrier Types summary: Create InsuranceCarrierType description: Creates a new InsuranceCarrierType operationId: CreateInsuranceCarrierType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/InsuranceCarrierType' text/json: schema: $ref: '#/components/schemas/InsuranceCarrierType' application/*+json: schema: $ref: '#/components/schemas/InsuranceCarrierType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InsuranceCarrierTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/InsuranceCarrierTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/InsuranceCarrierTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Insurance Carrier Types summary: List InsuranceCarrierType description: Lists all InsuranceCarrierType operationId: ListInsuranceCarrierType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InsuranceCarrierTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/InsuranceCarrierTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/InsuranceCarrierTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/insurance-carrier-types/{carrierType}': get: tags: - Insurance Carrier Types summary: Get InsuranceCarrierType description: Gets InsuranceCarrierType operationId: GetInsuranceCarrierType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carrierType in: path description: Carrier Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InsuranceCarrierTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/InsuranceCarrierTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/InsuranceCarrierTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Insurance Carrier Types summary: Update InsuranceCarrierType description: Updates a specific InsuranceCarrierType. operationId: UpdateInsuranceCarrierType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carrierType in: path description: Carrier Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/InsuranceCarrierType' text/json: schema: $ref: '#/components/schemas/InsuranceCarrierType' application/*+json: schema: $ref: '#/components/schemas/InsuranceCarrierType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InsuranceCarrierTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/InsuranceCarrierTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/InsuranceCarrierTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Insurance Carrier Types summary: Delete InsuranceCarrierType description: Deletes an InsuranceCarrierType operationId: DeleteInsuranceCarrierType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: carrierType in: path description: Carrier Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /insurance-carrier-types-batch: put: tags: - Insurance Carrier Types summary: Create or Update Batch InsuranceCarrierType description: 'Create or Update multiple InsuranceCarrierType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchInsuranceCarrierType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InsuranceCarrierType' text/json: schema: type: array items: $ref: '#/components/schemas/InsuranceCarrierType' application/*+json: schema: type: array items: $ref: '#/components/schemas/InsuranceCarrierType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /insurance-types: post: tags: - Insurance Types summary: Create InsuranceType description: Creates a new InsuranceType operationId: CreateInsuranceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/InsuranceType' text/json: schema: $ref: '#/components/schemas/InsuranceType' application/*+json: schema: $ref: '#/components/schemas/InsuranceType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InsuranceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/InsuranceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/InsuranceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Insurance Types summary: List InsuranceType description: Lists all InsuranceType operationId: ListInsuranceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InsuranceTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/InsuranceTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/InsuranceTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/insurance-types/{insuranceType}': get: tags: - Insurance Types summary: Get InsuranceType description: Gets InsuranceType operationId: GetInsuranceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: insuranceType in: path description: Insurance Type required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InsuranceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/InsuranceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/InsuranceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Insurance Types summary: Update InsuranceType description: Updates a specific InsuranceType. operationId: UpdateInsuranceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: insuranceType in: path description: Insurance Type required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/InsuranceType' text/json: schema: $ref: '#/components/schemas/InsuranceType' application/*+json: schema: $ref: '#/components/schemas/InsuranceType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InsuranceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/InsuranceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/InsuranceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Insurance Types summary: Delete InsuranceType description: Deletes an InsuranceType operationId: DeleteInsuranceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: insuranceType in: path description: Insurance Type required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /insurance-types-batch: put: tags: - Insurance Types summary: Create or Update Batch InsuranceType description: 'Create or Update multiple InsuranceType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchInsuranceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InsuranceType' text/json: schema: type: array items: $ref: '#/components/schemas/InsuranceType' application/*+json: schema: type: array items: $ref: '#/components/schemas/InsuranceType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /invoice-reasons: post: tags: - Invoice Reasons summary: Create InvoiceReason description: Creates a new InvoiceReason operationId: CreateInvoiceReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/InvoiceReason' text/json: schema: $ref: '#/components/schemas/InvoiceReason' application/*+json: schema: $ref: '#/components/schemas/InvoiceReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InvoiceReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/InvoiceReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/InvoiceReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Invoice Reasons summary: List InvoiceReason description: Lists all InvoiceReason operationId: ListInvoiceReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InvoiceReasonListVBAResponse' application/json: schema: $ref: '#/components/schemas/InvoiceReasonListVBAResponse' text/json: schema: $ref: '#/components/schemas/InvoiceReasonListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/invoice-reasons/{reasonKey}': get: tags: - Invoice Reasons summary: Get InvoiceReason description: Gets InvoiceReason operationId: GetInvoiceReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reasonKey in: path description: Reason Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InvoiceReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/InvoiceReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/InvoiceReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Invoice Reasons summary: Update InvoiceReason description: Updates a specific InvoiceReason. operationId: UpdateInvoiceReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reasonKey in: path description: Reason Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/InvoiceReason' text/json: schema: $ref: '#/components/schemas/InvoiceReason' application/*+json: schema: $ref: '#/components/schemas/InvoiceReason' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/InvoiceReasonVBAResponse' application/json: schema: $ref: '#/components/schemas/InvoiceReasonVBAResponse' text/json: schema: $ref: '#/components/schemas/InvoiceReasonVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Invoice Reasons summary: Delete InvoiceReason description: Deletes an InvoiceReason operationId: DeleteInvoiceReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reasonKey in: path description: Reason Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /invoice-reasons-batch: put: tags: - Invoice Reasons summary: Create or Update Batch InvoiceReason description: 'Create or Update multiple InvoiceReason at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchInvoiceReason parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InvoiceReason' text/json: schema: type: array items: $ref: '#/components/schemas/InvoiceReason' application/*+json: schema: type: array items: $ref: '#/components/schemas/InvoiceReason' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /ipwhitelists: post: tags: - IPWhitelists summary: Create IPWhitelist description: Creates a new IPWhitelist operationId: CreateIPWhitelist parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IPWhitelist' text/json: schema: $ref: '#/components/schemas/IPWhitelist' application/*+json: schema: $ref: '#/components/schemas/IPWhitelist' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IPWhitelistVBAResponse' application/json: schema: $ref: '#/components/schemas/IPWhitelistVBAResponse' text/json: schema: $ref: '#/components/schemas/IPWhitelistVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - IPWhitelists summary: List IPWhitelist description: Lists all IPWhitelist operationId: ListIPWhitelist parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IPWhitelistListVBAResponse' application/json: schema: $ref: '#/components/schemas/IPWhitelistListVBAResponse' text/json: schema: $ref: '#/components/schemas/IPWhitelistListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/ipwhitelists/{ipWhitelist_Key}': get: tags: - IPWhitelists summary: Get IPWhitelist description: Gets IPWhitelist operationId: GetIPWhitelist parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ipWhitelist_Key in: path description: IPWhitelist Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IPWhitelistVBAResponse' application/json: schema: $ref: '#/components/schemas/IPWhitelistVBAResponse' text/json: schema: $ref: '#/components/schemas/IPWhitelistVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - IPWhitelists summary: Update IPWhitelist description: Updates a specific IPWhitelist. operationId: UpdateIPWhitelist parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ipWhitelist_Key in: path description: IPWhitelist Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/IPWhitelist' text/json: schema: $ref: '#/components/schemas/IPWhitelist' application/*+json: schema: $ref: '#/components/schemas/IPWhitelist' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IPWhitelistVBAResponse' application/json: schema: $ref: '#/components/schemas/IPWhitelistVBAResponse' text/json: schema: $ref: '#/components/schemas/IPWhitelistVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - IPWhitelists summary: Delete IPWhitelist description: Deletes an IPWhitelist operationId: DeleteIPWhitelist parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ipWhitelist_Key in: path description: IPWhitelist Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /ipwhitelists-batch: put: tags: - IPWhitelists summary: Create or Update Batch IPWhitelist description: 'Create or Update multiple IPWhitelist at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchIPWhitelist parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPWhitelist' text/json: schema: type: array items: $ref: '#/components/schemas/IPWhitelist' application/*+json: schema: type: array items: $ref: '#/components/schemas/IPWhitelist' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/1094c': post: tags: - Group IRS 1094C summary: Create IRS1094C description: Creates a new IRS1094C operationId: CreateIRS1094C parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IRS1094C' text/json: schema: $ref: '#/components/schemas/IRS1094C' application/*+json: schema: $ref: '#/components/schemas/IRS1094C' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IRS1094CVBAResponse' application/json: schema: $ref: '#/components/schemas/IRS1094CVBAResponse' text/json: schema: $ref: '#/components/schemas/IRS1094CVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group IRS 1094C summary: List IRS1094C description: Lists all IRS1094C for the given groupID operationId: ListIRS1094C parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IRS1094CListVBAResponse' application/json: schema: $ref: '#/components/schemas/IRS1094CListVBAResponse' text/json: schema: $ref: '#/components/schemas/IRS1094CListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/1094c/{taxYear}': get: tags: - Group IRS 1094C summary: Get IRS1094C description: Gets IRS1094C operationId: GetIRS1094C parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: taxYear in: path description: Tax Year required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IRS1094CVBAResponse' application/json: schema: $ref: '#/components/schemas/IRS1094CVBAResponse' text/json: schema: $ref: '#/components/schemas/IRS1094CVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group IRS 1094C summary: Update IRS1094C description: Updates a specific IRS1094C. operationId: UpdateIRS1094C parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: taxYear in: path description: Tax Year required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IRS1094C' text/json: schema: $ref: '#/components/schemas/IRS1094C' application/*+json: schema: $ref: '#/components/schemas/IRS1094C' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IRS1094CVBAResponse' application/json: schema: $ref: '#/components/schemas/IRS1094CVBAResponse' text/json: schema: $ref: '#/components/schemas/IRS1094CVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group IRS 1094C summary: Delete IRS1094C description: Deletes an IRS1094C operationId: DeleteIRS1094C parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: taxYear in: path description: Tax Year required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/1094c-batch': put: tags: - Group IRS 1094C summary: Create or Update Batch IRS1094C description: 'Create or Update multiple IRS1094C at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchIRS1094C parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IRS1094C' text/json: schema: type: array items: $ref: '#/components/schemas/IRS1094C' application/*+json: schema: type: array items: $ref: '#/components/schemas/IRS1094C' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/1995b': post: tags: - Group IRS 1095B summary: Create IRS1095B description: Creates a new IRS1095B operationId: CreateIRS1095B parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IRS1095B' text/json: schema: $ref: '#/components/schemas/IRS1095B' application/*+json: schema: $ref: '#/components/schemas/IRS1095B' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IRS1095BVBAResponse' application/json: schema: $ref: '#/components/schemas/IRS1095BVBAResponse' text/json: schema: $ref: '#/components/schemas/IRS1095BVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group IRS 1095B summary: List IRS1095B description: Lists all IRS1095B for the given groupID operationId: ListIRS1095B parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IRS1095BListVBAResponse' application/json: schema: $ref: '#/components/schemas/IRS1095BListVBAResponse' text/json: schema: $ref: '#/components/schemas/IRS1095BListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/1995b/{taxYear}': get: tags: - Group IRS 1095B summary: Get IRS1095B description: Gets IRS1095B operationId: GetIRS1095B parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: taxYear in: path description: Tax Year required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IRS1095BVBAResponse' application/json: schema: $ref: '#/components/schemas/IRS1095BVBAResponse' text/json: schema: $ref: '#/components/schemas/IRS1095BVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group IRS 1095B summary: Update IRS1095B description: Updates a specific IRS1095B. operationId: UpdateIRS1095B parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: taxYear in: path description: Tax Year required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IRS1095B' text/json: schema: $ref: '#/components/schemas/IRS1095B' application/*+json: schema: $ref: '#/components/schemas/IRS1095B' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IRS1095BVBAResponse' application/json: schema: $ref: '#/components/schemas/IRS1095BVBAResponse' text/json: schema: $ref: '#/components/schemas/IRS1095BVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group IRS 1095B summary: Delete IRS1095B description: Deletes an IRS1095B operationId: DeleteIRS1095B parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: taxYear in: path description: Tax Year required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/1995b-batch': put: tags: - Group IRS 1095B summary: Create or Update Batch IRS1095B description: 'Create or Update multiple IRS1095B at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchIRS1095B parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IRS1095B' text/json: schema: type: array items: $ref: '#/components/schemas/IRS1095B' application/*+json: schema: type: array items: $ref: '#/components/schemas/IRS1095B' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /issue-duration-values: post: tags: - Issue Duration Values summary: Create IssueDurationValue description: Creates a new IssueDurationValue operationId: CreateIssueDurationValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IssueDurationValue' text/json: schema: $ref: '#/components/schemas/IssueDurationValue' application/*+json: schema: $ref: '#/components/schemas/IssueDurationValue' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IssueDurationValueVBAResponse' application/json: schema: $ref: '#/components/schemas/IssueDurationValueVBAResponse' text/json: schema: $ref: '#/components/schemas/IssueDurationValueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Issue Duration Values summary: List IssueDurationValue description: Lists all IssueDurationValue operationId: ListIssueDurationValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Type Filter in: query description: Type Filter schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IssueDurationValueListVBAResponse' application/json: schema: $ref: '#/components/schemas/IssueDurationValueListVBAResponse' text/json: schema: $ref: '#/components/schemas/IssueDurationValueListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/issue-duration-values/{issueDurationValueKey}': get: tags: - Issue Duration Values summary: Get IssueDurationValue description: Gets IssueDurationValue operationId: GetIssueDurationValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: issueDurationValueKey in: path description: IssueDurationValue Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IssueDurationValueVBAResponse' application/json: schema: $ref: '#/components/schemas/IssueDurationValueVBAResponse' text/json: schema: $ref: '#/components/schemas/IssueDurationValueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Issue Duration Values summary: Update IssueDurationValue description: Updates a specific IssueDurationValue. operationId: UpdateIssueDurationValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: issueDurationValueKey in: path description: IssueDurationValue Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/IssueDurationValue' text/json: schema: $ref: '#/components/schemas/IssueDurationValue' application/*+json: schema: $ref: '#/components/schemas/IssueDurationValue' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/IssueDurationValueVBAResponse' application/json: schema: $ref: '#/components/schemas/IssueDurationValueVBAResponse' text/json: schema: $ref: '#/components/schemas/IssueDurationValueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Issue Duration Values summary: Delete IssueDurationValue description: Deletes an IssueDurationValue operationId: DeleteIssueDurationValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: issueDurationValueKey in: path description: IssueDurationValue Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /issue-duration-values-batch: put: tags: - Issue Duration Values summary: Create or Update Batch IssueDurationValue description: 'Create or Update multiple IssueDurationValue at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchIssueDurationValue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IssueDurationValue' text/json: schema: type: array items: $ref: '#/components/schemas/IssueDurationValue' application/*+json: schema: type: array items: $ref: '#/components/schemas/IssueDurationValue' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /jobs: post: tags: - Jobs summary: Create Job description: Creates a new Job operationId: CreateJob parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Job' text/json: schema: $ref: '#/components/schemas/Job' application/*+json: schema: $ref: '#/components/schemas/Job' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobVBAResponse' application/json: schema: $ref: '#/components/schemas/JobVBAResponse' text/json: schema: $ref: '#/components/schemas/JobVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Jobs summary: List Job description: Lists all Job operationId: ListJob parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobListVBAResponse' application/json: schema: $ref: '#/components/schemas/JobListVBAResponse' text/json: schema: $ref: '#/components/schemas/JobListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/jobs/{jobID}': get: tags: - Jobs summary: Get Job description: Gets Job operationId: GetJob parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobVBAResponse' application/json: schema: $ref: '#/components/schemas/JobVBAResponse' text/json: schema: $ref: '#/components/schemas/JobVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Jobs summary: Update Job description: Updates a specific Job. operationId: UpdateJob parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Job' text/json: schema: $ref: '#/components/schemas/Job' application/*+json: schema: $ref: '#/components/schemas/Job' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobVBAResponse' application/json: schema: $ref: '#/components/schemas/JobVBAResponse' text/json: schema: $ref: '#/components/schemas/JobVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Jobs summary: Delete Job description: Deletes an Job operationId: DeleteJob parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /jobs-batch: put: tags: - Jobs summary: Create or Update Batch Job description: 'Create or Update multiple Job at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchJob parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Job' text/json: schema: type: array items: $ref: '#/components/schemas/Job' application/*+json: schema: type: array items: $ref: '#/components/schemas/Job' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/jobs/{jobID}/executions': post: tags: - Job Executions summary: Create JobExecution description: Creates a new JobExecution operationId: CreateJobExecution parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/JobExecution' text/json: schema: $ref: '#/components/schemas/JobExecution' application/*+json: schema: $ref: '#/components/schemas/JobExecution' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobExecutionVBAResponse' application/json: schema: $ref: '#/components/schemas/JobExecutionVBAResponse' text/json: schema: $ref: '#/components/schemas/JobExecutionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Job Executions summary: List JobExecution description: Lists all JobExecution for the given jobID operationId: ListJobExecution parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobExecutionListVBAResponse' application/json: schema: $ref: '#/components/schemas/JobExecutionListVBAResponse' text/json: schema: $ref: '#/components/schemas/JobExecutionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/jobs/{jobID}/executions/{jobExecutionKey}': get: tags: - Job Executions summary: Get JobExecution description: Gets JobExecution operationId: GetJobExecution parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string - name: jobExecutionKey in: path description: JobExecution Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobExecutionVBAResponse' application/json: schema: $ref: '#/components/schemas/JobExecutionVBAResponse' text/json: schema: $ref: '#/components/schemas/JobExecutionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Job Executions summary: Update JobExecution description: Updates a specific JobExecution. operationId: UpdateJobExecution parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string - name: jobExecutionKey in: path description: JobExecution Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/JobExecution' text/json: schema: $ref: '#/components/schemas/JobExecution' application/*+json: schema: $ref: '#/components/schemas/JobExecution' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobExecutionVBAResponse' application/json: schema: $ref: '#/components/schemas/JobExecutionVBAResponse' text/json: schema: $ref: '#/components/schemas/JobExecutionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Job Executions summary: Delete JobExecution description: Deletes an JobExecution operationId: DeleteJobExecution parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string - name: jobExecutionKey in: path description: JobExecution Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/jobs/{jobID}/executions-batch': put: tags: - Job Executions summary: Create or Update Batch JobExecution description: 'Create or Update multiple JobExecution at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchJobExecution parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/JobExecution' text/json: schema: type: array items: $ref: '#/components/schemas/JobExecution' application/*+json: schema: type: array items: $ref: '#/components/schemas/JobExecution' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/jobs/{jobID}/executions/{jobExecutionKey}/metadata': post: tags: - Job Execution Metadata summary: Create JobExecutionMetaData description: Creates a new JobExecutionMetaData operationId: CreateJobExecutionMetaData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string - name: jobExecutionKey in: path description: JobExecution Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/JobExecutionMetaData' text/json: schema: $ref: '#/components/schemas/JobExecutionMetaData' application/*+json: schema: $ref: '#/components/schemas/JobExecutionMetaData' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobExecutionMetaDataVBAResponse' application/json: schema: $ref: '#/components/schemas/JobExecutionMetaDataVBAResponse' text/json: schema: $ref: '#/components/schemas/JobExecutionMetaDataVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Job Execution Metadata summary: List JobExecutionMetaData description: Lists all JobExecutionMetaData for the given jobExecutionKey operationId: ListJobExecutionMetaData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string - name: jobExecutionKey in: path description: JobExecution Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobExecutionMetaDataListVBAResponse' application/json: schema: $ref: '#/components/schemas/JobExecutionMetaDataListVBAResponse' text/json: schema: $ref: '#/components/schemas/JobExecutionMetaDataListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/jobs/{jobID}/executions/{jobExecutionKey}/metadata/{jobExecutionAttribute}': get: tags: - Job Execution Metadata summary: Get JobExecutionMetaData description: Gets JobExecutionMetaData operationId: GetJobExecutionMetaData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string - name: jobExecutionKey in: path description: JobExecution Key required: true schema: type: integer format: int32 - name: jobExecutionAttribute in: path description: JobExecution Attribute required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobExecutionMetaDataVBAResponse' application/json: schema: $ref: '#/components/schemas/JobExecutionMetaDataVBAResponse' text/json: schema: $ref: '#/components/schemas/JobExecutionMetaDataVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Job Execution Metadata summary: Update JobExecutionMetaData description: Updates a specific JobExecutionMetaData. operationId: UpdateJobExecutionMetaData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string - name: jobExecutionKey in: path description: JobExecution Key required: true schema: type: integer format: int32 - name: jobExecutionAttribute in: path description: JobExecution Attribute required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/JobExecutionMetaData' text/json: schema: $ref: '#/components/schemas/JobExecutionMetaData' application/*+json: schema: $ref: '#/components/schemas/JobExecutionMetaData' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobExecutionMetaDataVBAResponse' application/json: schema: $ref: '#/components/schemas/JobExecutionMetaDataVBAResponse' text/json: schema: $ref: '#/components/schemas/JobExecutionMetaDataVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Job Execution Metadata summary: Delete JobExecutionMetaData description: Deletes an JobExecutionMetaData operationId: DeleteJobExecutionMetaData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string - name: jobExecutionKey in: path description: JobExecution Key required: true schema: type: integer format: int32 - name: jobExecutionAttribute in: path description: JobExecution Attribute required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/jobs/{jobID}/executions/{jobExecutionKey}/metadata-batch': put: tags: - Job Execution Metadata summary: Create or Update Batch JobExecutionMetaData description: 'Create or Update multiple JobExecutionMetaData at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchJobExecutionMetaData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobID in: path description: Job ID required: true schema: type: string - name: jobExecutionKey in: path description: JobExecution Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/JobExecutionMetaData' text/json: schema: type: array items: $ref: '#/components/schemas/JobExecutionMetaData' application/*+json: schema: type: array items: $ref: '#/components/schemas/JobExecutionMetaData' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /job-types: post: tags: - Job Types summary: Create JobType description: Creates a new JobType operationId: CreateJobType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/JobType' text/json: schema: $ref: '#/components/schemas/JobType' application/*+json: schema: $ref: '#/components/schemas/JobType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/JobTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/JobTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Job Types summary: List JobType description: Lists all JobType operationId: ListJobType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/JobTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/JobTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/job-types/{jobType}': get: tags: - Job Types summary: Get JobType description: Gets JobType operationId: GetJobType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobType in: path description: Job Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/JobTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/JobTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Job Types summary: Update JobType description: Updates a specific JobType. operationId: UpdateJobType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobType in: path description: Job Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/JobType' text/json: schema: $ref: '#/components/schemas/JobType' application/*+json: schema: $ref: '#/components/schemas/JobType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/JobTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/JobTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/JobTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Job Types summary: Delete JobType description: Deletes an JobType operationId: DeleteJobType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: jobType in: path description: Job Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /job-types-batch: put: tags: - Job Types summary: Create or Update Batch JobType description: 'Create or Update multiple JobType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchJobType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/JobType' text/json: schema: type: array items: $ref: '#/components/schemas/JobType' application/*+json: schema: type: array items: $ref: '#/components/schemas/JobType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /languages: post: tags: - Languages summary: Create Languages description: Creates a new Languages operationId: CreateLanguages parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Languages' text/json: schema: $ref: '#/components/schemas/Languages' application/*+json: schema: $ref: '#/components/schemas/Languages' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/LanguagesVBAResponse' application/json: schema: $ref: '#/components/schemas/LanguagesVBAResponse' text/json: schema: $ref: '#/components/schemas/LanguagesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Languages summary: List Languages description: Lists all Languages operationId: ListLanguages parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/LanguagesListVBAResponse' application/json: schema: $ref: '#/components/schemas/LanguagesListVBAResponse' text/json: schema: $ref: '#/components/schemas/LanguagesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/languages/{languageID}': get: tags: - Languages summary: Get Languages description: Gets Languages operationId: GetLanguages parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: languageID in: path description: Language ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/LanguagesVBAResponse' application/json: schema: $ref: '#/components/schemas/LanguagesVBAResponse' text/json: schema: $ref: '#/components/schemas/LanguagesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Languages summary: Update Languages description: Updates a specific Languages. operationId: UpdateLanguages parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: languageID in: path description: Language ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Languages' text/json: schema: $ref: '#/components/schemas/Languages' application/*+json: schema: $ref: '#/components/schemas/Languages' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/LanguagesVBAResponse' application/json: schema: $ref: '#/components/schemas/LanguagesVBAResponse' text/json: schema: $ref: '#/components/schemas/LanguagesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Languages summary: Delete Languages description: Deletes an Languages operationId: DeleteLanguages parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: languageID in: path description: Language ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /languages-batch: put: tags: - Languages summary: Create or Update Batch Languages description: 'Create or Update multiple Languages at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchLanguages parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Languages' text/json: schema: type: array items: $ref: '#/components/schemas/Languages' application/*+json: schema: type: array items: $ref: '#/components/schemas/Languages' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /local-taxes: post: tags: - Local Taxes summary: Create LocalTax description: Creates a new LocalTax operationId: CreateLocalTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalTax' text/json: schema: $ref: '#/components/schemas/LocalTax' application/*+json: schema: $ref: '#/components/schemas/LocalTax' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/LocalTaxVBAResponse' application/json: schema: $ref: '#/components/schemas/LocalTaxVBAResponse' text/json: schema: $ref: '#/components/schemas/LocalTaxVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Local Taxes summary: List LocalTax description: Lists all LocalTax operationId: ListLocalTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/LocalTaxListVBAResponse' application/json: schema: $ref: '#/components/schemas/LocalTaxListVBAResponse' text/json: schema: $ref: '#/components/schemas/LocalTaxListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/local-taxes/{localTaxCode}': get: tags: - Local Taxes summary: Get LocalTax description: Gets LocalTax operationId: GetLocalTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: localTaxCode in: path description: Local Tax Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/LocalTaxVBAResponse' application/json: schema: $ref: '#/components/schemas/LocalTaxVBAResponse' text/json: schema: $ref: '#/components/schemas/LocalTaxVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Local Taxes summary: Delete LocalTax description: Deletes an LocalTax operationId: DeleteLocalTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: localTaxCode in: path description: Local Tax Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /local-taxes-batch: put: tags: - Local Taxes summary: Create Batch LocalTax description: 'Create multiple LocalTax at once. If the entity exists, an error will be returned for that item. If the entity does not exist, it will be created.' operationId: CreateBatchLocalTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/LocalTax' text/json: schema: type: array items: $ref: '#/components/schemas/LocalTax' application/*+json: schema: type: array items: $ref: '#/components/schemas/LocalTax' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/log-types/{name}': get: tags: - LogType summary: Get LogType description: Gets LogType operationId: GetLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: name in: path description: LogType Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/LogTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/LogTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/LogTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /log-types: get: tags: - LogType summary: List all LogTypes description: List all available LogTypes operationId: ListLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/LogTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/LogTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/LogTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /marital-statuses: post: tags: - Marital Statuses summary: Create MaritalStatus description: Creates a new MaritalStatus operationId: CreateMaritalStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MaritalStatus' text/json: schema: $ref: '#/components/schemas/MaritalStatus' application/*+json: schema: $ref: '#/components/schemas/MaritalStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MaritalStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/MaritalStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/MaritalStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Marital Statuses summary: List MaritalStatus description: 'Lists all MaritalStatus ' operationId: ListMaritalStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MaritalStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/MaritalStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/MaritalStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/marital-statuses/{maritalStatus}': get: tags: - Marital Statuses summary: Get MaritalStatus description: Gets MaritalStatus operationId: GetMaritalStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: maritalStatus in: path description: Marital Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MaritalStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/MaritalStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/MaritalStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Marital Statuses summary: Update MaritalStatus description: Updates a specific MaritalStatus. operationId: UpdateMaritalStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: maritalStatus in: path description: Marital Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MaritalStatus' text/json: schema: $ref: '#/components/schemas/MaritalStatus' application/*+json: schema: $ref: '#/components/schemas/MaritalStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MaritalStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/MaritalStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/MaritalStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Marital Statuses summary: Delete MaritalStatus description: Deletes an MaritalStatus operationId: DeleteMaritalStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: maritalStatus in: path description: Marital Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /marital-statuses-batch: put: tags: - Marital Statuses summary: Create or Update Batch MaritalStatus description: 'Create or Update multiple MaritalStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMaritalStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MaritalStatus' text/json: schema: type: array items: $ref: '#/components/schemas/MaritalStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/MaritalStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/accounts': post: tags: - Member Accounts summary: Create MemberAccount description: Creates a new MemberAccount operationId: CreateMemberAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberAccount' text/json: schema: $ref: '#/components/schemas/MemberAccount' application/*+json: schema: $ref: '#/components/schemas/MemberAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Accounts summary: List MemberAccount description: Lists all MemberAccount for the given member operationId: ListMemberAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccountListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccountListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccountListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/accounts/{memberAccountKey}': get: tags: - Member Accounts summary: Get MemberAccount description: Gets MemberAccount operationId: GetMemberAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Accounts summary: Update MemberAccount description: Updates a specific MemberAccount. operationId: UpdateMemberAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberAccount' text/json: schema: $ref: '#/components/schemas/MemberAccount' application/*+json: schema: $ref: '#/components/schemas/MemberAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Accounts summary: Delete MemberAccount description: Deletes an MemberAccount operationId: DeleteMemberAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/accounts-batch': put: tags: - Member Accounts summary: Create or Update Batch MemberAccount description: 'Create or Update multiple MemberAccount at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberAccount' text/json: schema: type: array items: $ref: '#/components/schemas/MemberAccount' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberAccount' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/accounts/{memberAccountKey}/plans': post: tags: - Member Account Plans summary: Create MemberAccountPlan description: Creates a new MemberAccountPlan operationId: CreateMemberAccountPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberAccountPlan' text/json: schema: $ref: '#/components/schemas/MemberAccountPlan' application/*+json: schema: $ref: '#/components/schemas/MemberAccountPlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccountPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccountPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccountPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Account Plans summary: List MemberAccountPlan description: Lists all MemberAccountPlan for the given memberAccountKey operationId: ListMemberAccountPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccountPlanListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccountPlanListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccountPlanListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/accounts/{memberAccountKey}/plans/{planID}': get: tags: - Member Account Plans summary: Get MemberAccountPlan description: Gets MemberAccountPlan operationId: GetMemberAccountPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccountPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccountPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccountPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Account Plans summary: Update MemberAccountPlan description: Updates a specific MemberAccountPlan. operationId: UpdateMemberAccountPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberAccountPlan' text/json: schema: $ref: '#/components/schemas/MemberAccountPlan' application/*+json: schema: $ref: '#/components/schemas/MemberAccountPlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccountPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccountPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccountPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Account Plans summary: Delete MemberAccountPlan description: Deletes an MemberAccountPlan operationId: DeleteMemberAccountPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/accounts/{memberAccountKey}/plans-batch': put: tags: - Member Account Plans summary: Create or Update Batch MemberAccountPlan description: 'Create or Update multiple MemberAccountPlan at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberAccountPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberAccountPlan' text/json: schema: type: array items: $ref: '#/components/schemas/MemberAccountPlan' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberAccountPlan' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/accounts/{memberAccountKey}/plans/{planID}/payments': post: tags: - Member Account Plan Payments summary: Create MemberAccountPlanPayment description: Creates a new MemberAccountPlanPayment operationId: CreateMemberAccountPlanPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberAccountPlanPayment' text/json: schema: $ref: '#/components/schemas/MemberAccountPlanPayment' application/*+json: schema: $ref: '#/components/schemas/MemberAccountPlanPayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccountPlanPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccountPlanPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccountPlanPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Account Plan Payments summary: List MemberAccountPlanPayment description: Lists all MemberAccountPlanPayment for the given memberAccountKey and planID operationId: ListMemberAccountPlanPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccountPlanPaymentListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccountPlanPaymentListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccountPlanPaymentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/accounts/{memberAccountKey}/plans/{planID}/payments/{paymentKey}': get: tags: - Member Account Plan Payments summary: Get MemberAccountPlanPayment description: Gets MemberAccountPlanPayment operationId: GetMemberAccountPlanPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string - name: paymentKey in: path description: Payment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccountPlanPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccountPlanPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccountPlanPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Account Plan Payments summary: Update MemberAccountPlanPayment description: Updates a specific MemberAccountPlanPayment. operationId: UpdateMemberAccountPlanPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string - name: paymentKey in: path description: Payment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberAccountPlanPayment' text/json: schema: $ref: '#/components/schemas/MemberAccountPlanPayment' application/*+json: schema: $ref: '#/components/schemas/MemberAccountPlanPayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccountPlanPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccountPlanPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccountPlanPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Account Plan Payments summary: Delete MemberAccountPlanPayment description: Deletes an MemberAccountPlanPayment operationId: DeleteMemberAccountPlanPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string - name: paymentKey in: path description: Payment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/accounts/{memberAccountKey}/plans/{planID}/payments-batch': put: tags: - Member Account Plan Payments summary: Create or Update Batch MemberAccountPlanPayment description: 'Create or Update multiple MemberAccountPlanPayment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberAccountPlanPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberAccountKey in: path description: MemberAccount Key required: true schema: type: integer format: int32 - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberAccountPlanPayment' text/json: schema: type: array items: $ref: '#/components/schemas/MemberAccountPlanPayment' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberAccountPlanPayment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/accums': post: tags: - Member Accum summary: Create MemberAccum description: Creates a new MemberAccum operationId: CreateMemberAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberAccum' text/json: schema: $ref: '#/components/schemas/MemberAccum' application/*+json: schema: $ref: '#/components/schemas/MemberAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Accum summary: List MemberAccum description: Lists all MemberAccum for the given subscriberID and memberSeq operationId: ListMemberAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccumListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccumListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccumListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/accums/{groupID}/{planYear}/{planType}/{benefitCode}': get: tags: - Member Accum summary: Get MemberAccum description: Gets MemberAccum operationId: GetMemberAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Accum summary: Update MemberAccum description: Updates a specific MemberAccum. operationId: UpdateMemberAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberAccum' text/json: schema: $ref: '#/components/schemas/MemberAccum' application/*+json: schema: $ref: '#/components/schemas/MemberAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Accum summary: Delete MemberAccum description: Deletes an MemberAccum operationId: DeleteMemberAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/accums-batch': put: tags: - Member Accum summary: Create or Update Batch MemberAccum description: 'Create or Update multiple MemberAccum at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberAccum' text/json: schema: type: array items: $ref: '#/components/schemas/MemberAccum' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberAccum' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/addresses': post: tags: - Member Address summary: Create MemberAddress description: Creates a new MemberAddress operationId: CreateMemberAddress parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberAddress' text/json: schema: $ref: '#/components/schemas/MemberAddress' application/*+json: schema: $ref: '#/components/schemas/MemberAddress' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAddressVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAddressVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAddressVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Address summary: Get MemberAddress description: Gets MemberAddress operationId: GetMemberAddress parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAddressVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAddressVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAddressVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Address summary: Update MemberAddress description: Updates a specific MemberAddress. operationId: UpdateMemberAddress parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberAddress' text/json: schema: $ref: '#/components/schemas/MemberAddress' application/*+json: schema: $ref: '#/components/schemas/MemberAddress' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAddressVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAddressVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAddressVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Address summary: Delete MemberAddress description: Deletes an MemberAddress operationId: DeleteMemberAddress parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{Subscriber_ID}/members/{Member_Seq}/address-history': post: tags: - Member Address History summary: Create MemberAddressHistory description: Creates a new MemberAddressHistory operationId: CreateMemberAddressHistory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: Member_Seq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberAddressHistory' text/json: schema: $ref: '#/components/schemas/MemberAddressHistory' application/*+json: schema: $ref: '#/components/schemas/MemberAddressHistory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAddressHistoryVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAddressHistoryVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAddressHistoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Address History summary: List MemberAddressHistory description: Lists all MemberAddressHistory for the given Subscriber_ID and Member_Seq operationId: ListMemberAddressHistory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: Member_Seq in: path description: Member Seq required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAddressHistoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAddressHistoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAddressHistoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{Subscriber_ID}/members/{Member_Seq}/address-history/{MemberAddressHistory_Key}': get: tags: - Member Address History summary: Get MemberAddressHistory description: Gets MemberAddressHistory operationId: GetMemberAddressHistory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: Member_Seq in: path description: Member Seq required: true schema: type: string - name: MemberAddressHistory_Key in: path description: MemberAddressHistory Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAddressHistoryVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAddressHistoryVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAddressHistoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Address History summary: Update MemberAddressHistory description: Updates a specific MemberAddressHistory. operationId: UpdateMemberAddressHistory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: Member_Seq in: path description: Member Seq required: true schema: type: string - name: MemberAddressHistory_Key in: path description: MemberAddressHistory Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberAddressHistory' text/json: schema: $ref: '#/components/schemas/MemberAddressHistory' application/*+json: schema: $ref: '#/components/schemas/MemberAddressHistory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberAddressHistoryVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberAddressHistoryVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberAddressHistoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Address History summary: Delete MemberAddressHistory description: Deletes an MemberAddressHistory operationId: DeleteMemberAddressHistory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: Member_Seq in: path description: Member Seq required: true schema: type: string - name: MemberAddressHistory_Key in: path description: MemberAddressHistory Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{Subscriber_ID}/members/{Member_Seq}/address-history-batch': put: tags: - Member Address History summary: Create or Update Batch MemberAddressHistory description: 'Create or Update multiple MemberAddressHistory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberAddressHistory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: Member_Seq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberAddressHistory' text/json: schema: type: array items: $ref: '#/components/schemas/MemberAddressHistory' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberAddressHistory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries': post: tags: - Member Beneficiary summary: Create MemberBeneficiary description: Creates a new MemberBeneficiary operationId: CreateMemberBeneficiary parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberBeneficiary' text/json: schema: $ref: '#/components/schemas/MemberBeneficiary' application/*+json: schema: $ref: '#/components/schemas/MemberBeneficiary' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberBeneficiaryVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberBeneficiaryVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberBeneficiaryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Beneficiary summary: List MemberBeneficiary description: Lists all MemberBeneficiary for the given subscriberID and memberSeq operationId: ListMemberBeneficiary parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberBeneficiaryListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberBeneficiaryListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberBeneficiaryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}': get: tags: - Member Beneficiary summary: Get MemberBeneficiary description: Gets MemberBeneficiary operationId: GetMemberBeneficiary parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: beneficiaryID in: path description: Beneficiary ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberBeneficiaryVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberBeneficiaryVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberBeneficiaryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Beneficiary summary: Update MemberBeneficiary description: Updates a specific MemberBeneficiary. operationId: UpdateMemberBeneficiary parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: beneficiaryID in: path description: Beneficiary ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberBeneficiary' text/json: schema: $ref: '#/components/schemas/MemberBeneficiary' application/*+json: schema: $ref: '#/components/schemas/MemberBeneficiary' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberBeneficiaryVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberBeneficiaryVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberBeneficiaryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Beneficiary summary: Delete MemberBeneficiary description: Deletes an MemberBeneficiary operationId: DeleteMemberBeneficiary parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: beneficiaryID in: path description: Beneficiary ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries-batch': put: tags: - Member Beneficiary summary: Create or Update Batch MemberBeneficiary description: 'Create or Update multiple MemberBeneficiary at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberBeneficiary parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberBeneficiary' text/json: schema: type: array items: $ref: '#/components/schemas/MemberBeneficiary' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberBeneficiary' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}/plans': post: tags: - Member Beneficiary Plans summary: Create MemberBeneficiaryPlan description: Creates a new MemberBeneficiaryPlan operationId: CreateMemberBeneficiaryPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: beneficiaryID in: path description: Beneficiary ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlan' text/json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlan' application/*+json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberBeneficiaryPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Beneficiary Plans summary: List MemberBeneficiaryPlan description: Lists all MemberBeneficiaryPlan for the given subscriberID and memberSeq and beneficiaryID operationId: ListMemberBeneficiaryPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: beneficiaryID in: path description: Beneficiary ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberBeneficiaryPlanListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlanListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlanListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}/plans/{planID}': get: tags: - Member Beneficiary Plans summary: Get MemberBeneficiaryPlan description: Gets MemberBeneficiaryPlan operationId: GetMemberBeneficiaryPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: beneficiaryID in: path description: Beneficiary ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberBeneficiaryPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Beneficiary Plans summary: Update MemberBeneficiaryPlan description: Updates a specific MemberBeneficiaryPlan. operationId: UpdateMemberBeneficiaryPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: beneficiaryID in: path description: Beneficiary ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlan' text/json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlan' application/*+json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberBeneficiaryPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberBeneficiaryPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Beneficiary Plans summary: Delete MemberBeneficiaryPlan description: Deletes an MemberBeneficiaryPlan operationId: DeleteMemberBeneficiaryPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: beneficiaryID in: path description: Beneficiary ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}/plans-batch': put: tags: - Member Beneficiary Plans summary: Create or Update Batch MemberBeneficiaryPlan description: 'Create or Update multiple MemberBeneficiaryPlan at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberBeneficiaryPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: beneficiaryID in: path description: Beneficiary ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberBeneficiaryPlan' text/json: schema: type: array items: $ref: '#/components/schemas/MemberBeneficiaryPlan' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberBeneficiaryPlan' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/care-alerts': post: tags: - Member Care Alerts summary: Create MemberCareAlert description: Creates a new MemberCareAlert operationId: CreateMemberCareAlert parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberCareAlert' text/json: schema: $ref: '#/components/schemas/MemberCareAlert' application/*+json: schema: $ref: '#/components/schemas/MemberCareAlert' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCareAlertVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCareAlertVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCareAlertVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Care Alerts summary: List MemberCareAlert description: Lists all MemberCareAlert for the given subscriberID and memberSeq operationId: ListMemberCareAlert parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCareAlertListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCareAlertListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCareAlertListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/care-alerts/{memberCareAlertKey}': get: tags: - Member Care Alerts summary: Get MemberCareAlert description: Gets MemberCareAlert operationId: GetMemberCareAlert parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberCareAlertKey in: path description: MemberCareAlert Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCareAlertVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCareAlertVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCareAlertVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Care Alerts summary: Update MemberCareAlert description: Updates a specific MemberCareAlert. operationId: UpdateMemberCareAlert parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberCareAlertKey in: path description: MemberCareAlert Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberCareAlert' text/json: schema: $ref: '#/components/schemas/MemberCareAlert' application/*+json: schema: $ref: '#/components/schemas/MemberCareAlert' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCareAlertVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCareAlertVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCareAlertVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Care Alerts summary: Delete MemberCareAlert description: Deletes an MemberCareAlert operationId: DeleteMemberCareAlert parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberCareAlertKey in: path description: MemberCareAlert Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/care-alerts-batch': put: tags: - Member Care Alerts summary: Create or Update Batch MemberCareAlert description: 'Create or Update multiple MemberCareAlert at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberCareAlert parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberCareAlert' text/json: schema: type: array items: $ref: '#/components/schemas/MemberCareAlert' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberCareAlert' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/case-heads': post: tags: - Member Case Heads summary: Create MemberCaseHead description: Creates a new MemberCaseHead operationId: CreateMemberCaseHead parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberCaseHead' text/json: schema: $ref: '#/components/schemas/MemberCaseHead' application/*+json: schema: $ref: '#/components/schemas/MemberCaseHead' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCaseHeadVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCaseHeadVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCaseHeadVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Case Heads summary: List MemberCaseHead description: Lists all MemberCaseHead for the given subscriberID and memberSeq operationId: ListMemberCaseHead parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCaseHeadListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCaseHeadListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCaseHeadListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/case-heads/{memberCaseHeadKey}': get: tags: - Member Case Heads summary: Get MemberCaseHead description: Gets MemberCaseHead operationId: GetMemberCaseHead parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberCaseHeadKey in: path description: MemberCaseHead Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCaseHeadVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCaseHeadVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCaseHeadVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Case Heads summary: Update MemberCaseHead description: Updates a specific MemberCaseHead. operationId: UpdateMemberCaseHead parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberCaseHeadKey in: path description: MemberCaseHead Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberCaseHead' text/json: schema: $ref: '#/components/schemas/MemberCaseHead' application/*+json: schema: $ref: '#/components/schemas/MemberCaseHead' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCaseHeadVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCaseHeadVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCaseHeadVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Case Heads summary: Delete MemberCaseHead description: Deletes an MemberCaseHead operationId: DeleteMemberCaseHead parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberCaseHeadKey in: path description: MemberCaseHead Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/case-heads-batch': put: tags: - Member Case Heads summary: Create or Update Batch MemberCaseHead description: 'Create or Update multiple MemberCaseHead at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberCaseHead parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberCaseHead' text/json: schema: type: array items: $ref: '#/components/schemas/MemberCaseHead' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberCaseHead' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/classes': post: tags: - Member Classes summary: Create MemberClass description: Creates a new MemberClass operationId: CreateMemberClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberClass' text/json: schema: $ref: '#/components/schemas/MemberClass' application/*+json: schema: $ref: '#/components/schemas/MemberClass' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberClassVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberClassVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberClassVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Classes summary: List MemberClass description: Lists all MemberClass for the given subscriberID and memberSeq operationId: ListMemberClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberClassListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberClassListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberClassListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/classes/{memberClassKey}': get: tags: - Member Classes summary: Get MemberClass description: Gets MemberClass operationId: GetMemberClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberClassKey in: path description: MemberClass Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberClassVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberClassVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberClassVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Classes summary: Update MemberClass description: Updates a specific MemberClass. operationId: UpdateMemberClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberClassKey in: path description: MemberClass Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberClass' text/json: schema: $ref: '#/components/schemas/MemberClass' application/*+json: schema: $ref: '#/components/schemas/MemberClass' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberClassVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberClassVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberClassVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Classes summary: Delete MemberClass description: Deletes an MemberClass operationId: DeleteMemberClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberClassKey in: path description: MemberClass Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/classes-batch': put: tags: - Member Classes summary: Create or Update Batch MemberClass description: 'Create or Update multiple MemberClass at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberClass parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberClass' text/json: schema: type: array items: $ref: '#/components/schemas/MemberClass' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberClass' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/cob-savings': post: tags: - Member COB Savings summary: Create MemberCOBSavings description: Creates a new MemberCOBSavings operationId: CreateMemberCOBSavings parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberCOBSavings' text/json: schema: $ref: '#/components/schemas/MemberCOBSavings' application/*+json: schema: $ref: '#/components/schemas/MemberCOBSavings' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCOBSavingsVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCOBSavingsVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCOBSavingsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member COB Savings summary: List MemberCOBSavings description: Lists all MemberCOBSavings for the given subscriberID and memberSeq operationId: ListMemberCOBSavings parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCOBSavingsListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCOBSavingsListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCOBSavingsListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/cob-savings/{memberCOBSavingsKey}': get: tags: - Member COB Savings summary: Get MemberCOBSavings description: Gets MemberCOBSavings operationId: GetMemberCOBSavings parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberCOBSavingsKey in: path description: MemberCOBSavings Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCOBSavingsVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCOBSavingsVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCOBSavingsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member COB Savings summary: Update MemberCOBSavings description: Updates a specific MemberCOBSavings. operationId: UpdateMemberCOBSavings parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberCOBSavingsKey in: path description: MemberCOBSavings Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberCOBSavings' text/json: schema: $ref: '#/components/schemas/MemberCOBSavings' application/*+json: schema: $ref: '#/components/schemas/MemberCOBSavings' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCOBSavingsVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCOBSavingsVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCOBSavingsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member COB Savings summary: Delete MemberCOBSavings description: Deletes an MemberCOBSavings operationId: DeleteMemberCOBSavings parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberCOBSavingsKey in: path description: MemberCOBSavings Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/cob-savings-batch': put: tags: - Member COB Savings summary: Create or Update Batch MemberCOBSavings description: 'Create or Update multiple MemberCOBSavings at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberCOBSavings parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberCOBSavings' text/json: schema: type: array items: $ref: '#/components/schemas/MemberCOBSavings' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberCOBSavings' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/colleges': post: tags: - Member Colleges summary: Create MemberCollege description: Creates a new MemberCollege operationId: CreateMemberCollege parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberCollege' text/json: schema: $ref: '#/components/schemas/MemberCollege' application/*+json: schema: $ref: '#/components/schemas/MemberCollege' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCollegeVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCollegeVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCollegeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Colleges summary: List MemberCollege description: Lists all MemberCollege for the given subscriberID and memberSeq operationId: ListMemberCollege parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCollegeListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCollegeListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCollegeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/colleges/{memberCollegeKey}': get: tags: - Member Colleges summary: Get MemberCollege description: Gets MemberCollege operationId: GetMemberCollege parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberCollegeKey in: path description: MemberCollege Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCollegeVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCollegeVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCollegeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Colleges summary: Update MemberCollege description: Updates a specific MemberCollege. operationId: UpdateMemberCollege parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberCollegeKey in: path description: MemberCollege Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberCollege' text/json: schema: $ref: '#/components/schemas/MemberCollege' application/*+json: schema: $ref: '#/components/schemas/MemberCollege' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberCollegeVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberCollegeVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberCollegeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Colleges summary: Delete MemberCollege description: Deletes an MemberCollege operationId: DeleteMemberCollege parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberCollegeKey in: path description: MemberCollege Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/colleges-batch': put: tags: - Member Colleges summary: Create or Update Batch MemberCollege description: 'Create or Update multiple MemberCollege at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberCollege parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberCollege' text/json: schema: type: array items: $ref: '#/components/schemas/MemberCollege' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberCollege' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/eligibility-statuses': post: tags: - Member Eligibility Status summary: Create MemberEligibilityStatus description: Creates a new MemberEligibilityStatus operationId: CreateMemberEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberEligibilityStatus' text/json: schema: $ref: '#/components/schemas/MemberEligibilityStatus' application/*+json: schema: $ref: '#/components/schemas/MemberEligibilityStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberEligibilityStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberEligibilityStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberEligibilityStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Eligibility Status summary: List MemberEligibilityStatus description: Lists all MemberEligibilityStatus for the given subscriberID and memberSeq operationId: ListMemberEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberEligibilityStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberEligibilityStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberEligibilityStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/eligibility-statuses/{memberEligibilityStatusKey}': get: tags: - Member Eligibility Status summary: Get MemberEligibilityStatus description: Gets MemberEligibilityStatus operationId: GetMemberEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberEligibilityStatusKey in: path description: MemberEligibilityStatus Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberEligibilityStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberEligibilityStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberEligibilityStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Eligibility Status summary: Update MemberEligibilityStatus description: Updates a specific MemberEligibilityStatus. operationId: UpdateMemberEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberEligibilityStatusKey in: path description: MemberEligibilityStatus Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberEligibilityStatus' text/json: schema: $ref: '#/components/schemas/MemberEligibilityStatus' application/*+json: schema: $ref: '#/components/schemas/MemberEligibilityStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberEligibilityStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberEligibilityStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberEligibilityStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Eligibility Status summary: Delete MemberEligibilityStatus description: Deletes an MemberEligibilityStatus operationId: DeleteMemberEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberEligibilityStatusKey in: path description: MemberEligibilityStatus Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/eligibility-statuses-batch': put: tags: - Member Eligibility Status summary: Create or Update Batch MemberEligibilityStatus description: 'Create or Update multiple MemberEligibilityStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberEligibilityStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberEligibilityStatus' text/json: schema: type: array items: $ref: '#/components/schemas/MemberEligibilityStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberEligibilityStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/printed-id-cards': post: tags: - Member ID Cards Printed summary: Create MemberIDCardPrinted description: Creates a new MemberIDCardPrinted operationId: CreateMemberIDCardPrinted parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberIDCardPrinted' text/json: schema: $ref: '#/components/schemas/MemberIDCardPrinted' application/*+json: schema: $ref: '#/components/schemas/MemberIDCardPrinted' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberIDCardPrintedVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberIDCardPrintedVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberIDCardPrintedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member ID Cards Printed summary: List MemberIDCardPrinted description: Lists all MemberIDCardPrinted for the given subscriberID and memberSeq operationId: ListMemberIDCardPrinted parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberIDCardPrintedListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberIDCardPrintedListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberIDCardPrintedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/printed-id-cards/{reportDefinitionKey}/{printedDate}': get: tags: - Member ID Cards Printed summary: Get MemberIDCardPrinted description: Gets MemberIDCardPrinted operationId: GetMemberIDCardPrinted parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: printedDate in: path description: Printed Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberIDCardPrintedVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberIDCardPrintedVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberIDCardPrintedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member ID Cards Printed summary: Update MemberIDCardPrinted description: Updates a specific MemberIDCardPrinted. operationId: UpdateMemberIDCardPrinted parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: printedDate in: path description: Printed Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberIDCardPrinted' text/json: schema: $ref: '#/components/schemas/MemberIDCardPrinted' application/*+json: schema: $ref: '#/components/schemas/MemberIDCardPrinted' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberIDCardPrintedVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberIDCardPrintedVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberIDCardPrintedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member ID Cards Printed summary: Delete MemberIDCardPrinted description: Deletes an MemberIDCardPrinted operationId: DeleteMemberIDCardPrinted parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: printedDate in: path description: Printed Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/printed-id-cards-batch': put: tags: - Member ID Cards Printed summary: Create or Update Batch MemberIDCardPrinted description: 'Create or Update multiple MemberIDCardPrinted at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberIDCardPrinted parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberIDCardPrinted' text/json: schema: type: array items: $ref: '#/components/schemas/MemberIDCardPrinted' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberIDCardPrinted' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/insurances': post: tags: - Member Insurance summary: Create MemberInsurance description: Creates a new MemberInsurance operationId: CreateMemberInsurance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberInsurance' text/json: schema: $ref: '#/components/schemas/MemberInsurance' application/*+json: schema: $ref: '#/components/schemas/MemberInsurance' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberInsuranceVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberInsuranceVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberInsuranceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Insurance summary: List MemberInsurance description: Lists all MemberInsurance for the given subscriberID and memberSeq operationId: ListMemberInsurance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberInsuranceListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberInsuranceListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberInsuranceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/insurances/{seqNumber}': get: tags: - Member Insurance summary: Get MemberInsurance description: Gets MemberInsurance operationId: GetMemberInsurance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: seqNumber in: path description: Seq Number required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberInsuranceVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberInsuranceVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberInsuranceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Insurance summary: Update MemberInsurance description: Updates a specific MemberInsurance. operationId: UpdateMemberInsurance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: seqNumber in: path description: Seq Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberInsurance' text/json: schema: $ref: '#/components/schemas/MemberInsurance' application/*+json: schema: $ref: '#/components/schemas/MemberInsurance' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberInsuranceVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberInsuranceVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberInsuranceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Insurance summary: Delete MemberInsurance description: Deletes an MemberInsurance operationId: DeleteMemberInsurance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: seqNumber in: path description: Seq Number required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/insurances-batch': put: tags: - Member Insurance summary: Create or Update Batch MemberInsurance description: 'Create or Update multiple MemberInsurance at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberInsurance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberInsurance' text/json: schema: type: array items: $ref: '#/components/schemas/MemberInsurance' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberInsurance' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/languages': post: tags: - Member Languages summary: Create MemberLanguage description: Creates a new MemberLanguage operationId: CreateMemberLanguage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberLanguage' text/json: schema: $ref: '#/components/schemas/MemberLanguage' application/*+json: schema: $ref: '#/components/schemas/MemberLanguage' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberLanguageVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberLanguageVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberLanguageVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Languages summary: List MemberLanguage description: Lists all MemberLanguage for the given subscriberID and memberSeq operationId: ListMemberLanguage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberLanguageListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberLanguageListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberLanguageListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/languages/{languageID}': get: tags: - Member Languages summary: Get MemberLanguage description: Gets MemberLanguage operationId: GetMemberLanguage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: languageID in: path description: Language ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberLanguageVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberLanguageVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberLanguageVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Languages summary: Update MemberLanguage description: Updates a specific MemberLanguage. operationId: UpdateMemberLanguage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: languageID in: path description: Language ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberLanguage' text/json: schema: $ref: '#/components/schemas/MemberLanguage' application/*+json: schema: $ref: '#/components/schemas/MemberLanguage' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberLanguageVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberLanguageVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberLanguageVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Languages summary: Delete MemberLanguage description: Deletes an MemberLanguage operationId: DeleteMemberLanguage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: languageID in: path description: Language ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/languages-batch': put: tags: - Member Languages summary: Create or Update Batch MemberLanguage description: 'Create or Update multiple MemberLanguage at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberLanguage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberLanguage' text/json: schema: type: array items: $ref: '#/components/schemas/MemberLanguage' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberLanguage' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/medicare-responsibilities': post: tags: - Member Medicare Reponsibility summary: Create MemberMedicareResp description: Creates a new MemberMedicareResp operationId: CreateMemberMedicareResp parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberMedicareResp' text/json: schema: $ref: '#/components/schemas/MemberMedicareResp' application/*+json: schema: $ref: '#/components/schemas/MemberMedicareResp' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberMedicareRespVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberMedicareRespVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberMedicareRespVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Medicare Reponsibility summary: List MemberMedicareResp description: Lists all MemberMedicareResp for the given subscriberID and memberSeq operationId: ListMemberMedicareResp parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberMedicareRespListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberMedicareRespListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberMedicareRespListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/medicare-responsibilities/{memberMedicareRespKey}': get: tags: - Member Medicare Reponsibility summary: Get MemberMedicareResp description: Gets MemberMedicareResp operationId: GetMemberMedicareResp parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberMedicareRespKey in: path description: MemberMedicareResp Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberMedicareRespVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberMedicareRespVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberMedicareRespVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Medicare Reponsibility summary: Update MemberMedicareResp description: Updates a specific MemberMedicareResp. operationId: UpdateMemberMedicareResp parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberMedicareRespKey in: path description: MemberMedicareResp Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberMedicareResp' text/json: schema: $ref: '#/components/schemas/MemberMedicareResp' application/*+json: schema: $ref: '#/components/schemas/MemberMedicareResp' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberMedicareRespVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberMedicareRespVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberMedicareRespVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Medicare Reponsibility summary: Delete MemberMedicareResp description: Deletes an MemberMedicareResp operationId: DeleteMemberMedicareResp parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberMedicareRespKey in: path description: MemberMedicareResp Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/medicare-responsibilities-batch': put: tags: - Member Medicare Reponsibility summary: Create or Update Batch MemberMedicareResp description: 'Create or Update multiple MemberMedicareResp at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberMedicareResp parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberMedicareResp' text/json: schema: type: array items: $ref: '#/components/schemas/MemberMedicareResp' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberMedicareResp' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/networks': post: tags: - Member Networks summary: Create MemberNetwork description: Creates a new MemberNetwork operationId: CreateMemberNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberNetwork' text/json: schema: $ref: '#/components/schemas/MemberNetwork' application/*+json: schema: $ref: '#/components/schemas/MemberNetwork' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Networks summary: List MemberNetwork description: Lists all MemberNetwork for the given subscriberID and memberSeq operationId: ListMemberNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberNetworkListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberNetworkListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberNetworkListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/networks/{networkID}/{groupID}/{divisionID}/{effectiveDate}': get: tags: - Member Networks summary: Get MemberNetwork description: Gets MemberNetwork operationId: GetMemberNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Networks summary: Update MemberNetwork description: Updates a specific MemberNetwork. operationId: UpdateMemberNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberNetwork' text/json: schema: $ref: '#/components/schemas/MemberNetwork' application/*+json: schema: $ref: '#/components/schemas/MemberNetwork' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Networks summary: Delete MemberNetwork description: Deletes an MemberNetwork operationId: DeleteMemberNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/networks-batch': put: tags: - Member Networks summary: Create or Update Batch MemberNetwork description: 'Create or Update multiple MemberNetwork at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberNetwork' text/json: schema: type: array items: $ref: '#/components/schemas/MemberNetwork' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberNetwork' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/occupations': post: tags: - Member Occupations summary: Create MemberOccupation description: Creates a new MemberOccupation operationId: CreateMemberOccupation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberOccupation' text/json: schema: $ref: '#/components/schemas/MemberOccupation' application/*+json: schema: $ref: '#/components/schemas/MemberOccupation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberOccupationVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberOccupationVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberOccupationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Occupations summary: List MemberOccupation description: Lists all MemberOccupation for the given subscriberID and memberSeq operationId: ListMemberOccupation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberOccupationListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberOccupationListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberOccupationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/occupations/{occupationID}/{effectiveDate}': get: tags: - Member Occupations summary: Get MemberOccupation description: Gets MemberOccupation operationId: GetMemberOccupation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: occupationID in: path description: Occupation ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberOccupationVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberOccupationVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberOccupationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Occupations summary: Update MemberOccupation description: Updates a specific MemberOccupation. operationId: UpdateMemberOccupation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: occupationID in: path description: Occupation ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberOccupation' text/json: schema: $ref: '#/components/schemas/MemberOccupation' application/*+json: schema: $ref: '#/components/schemas/MemberOccupation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberOccupationVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberOccupationVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberOccupationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Occupations summary: Delete MemberOccupation description: Deletes an MemberOccupation operationId: DeleteMemberOccupation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: occupationID in: path description: Occupation ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/occupations-batch': put: tags: - Member Occupations summary: Create or Update Batch MemberOccupation description: 'Create or Update multiple MemberOccupation at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberOccupation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberOccupation' text/json: schema: type: array items: $ref: '#/components/schemas/MemberOccupation' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberOccupation' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/payments': post: tags: - Member Payments summary: Create MemberPayment description: Creates a new MemberPayment operationId: CreateMemberPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberPayment' text/json: schema: $ref: '#/components/schemas/MemberPayment' application/*+json: schema: $ref: '#/components/schemas/MemberPayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Payments summary: List MemberPayment description: Lists all MemberPayment for the given subscriberID and memberSeq operationId: ListMemberPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPaymentListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPaymentListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPaymentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/payments-filtered': get: tags: - Member Payments summary: List MemberPayments Filtered description: 'Lists all MemberPayment for the given Subscriber ID, Member Seq, Group ID, Division ID, Group Coverage Start and Start Date' operationId: ListMemberPaymentFiltered parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: query description: Group ID required: true schema: type: string - name: divisionID in: query description: Division ID required: true schema: type: string - name: groupCoverageStart in: query description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: query description: Start Date required: true schema: type: string format: date-time - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPaymentListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPaymentListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPaymentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/payments/{memberPaymentKey}': get: tags: - Member Payments summary: Get MemberPayment description: Gets MemberPayment operationId: GetMemberPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberPaymentKey in: path description: MemberPayment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Payments summary: Update MemberPayment description: Updates a specific MemberPayment. operationId: UpdateMemberPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberPaymentKey in: path description: MemberPayment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberPayment' text/json: schema: $ref: '#/components/schemas/MemberPayment' application/*+json: schema: $ref: '#/components/schemas/MemberPayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Payments summary: Delete MemberPayment description: Deletes an MemberPayment operationId: DeleteMemberPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberPaymentKey in: path description: MemberPayment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/payments-batch': put: tags: - Member Payments summary: Create or Update Batch MemberPayment description: 'Create or Update multiple MemberPayment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberPayment' text/json: schema: type: array items: $ref: '#/components/schemas/MemberPayment' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberPayment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/plan-years': post: tags: - Member Plan Years summary: Create MemberPlanYear description: Creates a new MemberPlanYear operationId: CreateMemberPlanYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberPlanYear' text/json: schema: $ref: '#/components/schemas/MemberPlanYear' application/*+json: schema: $ref: '#/components/schemas/MemberPlanYear' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPlanYearVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPlanYearVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPlanYearVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Plan Years summary: List MemberPlanYear description: Lists all MemberPlanYear for the given subscriberID and memberSeq operationId: ListMemberPlanYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPlanYearListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPlanYearListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPlanYearListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/plan-years/{memberPlanYearKey}': get: tags: - Member Plan Years summary: Get MemberPlanYear description: Gets MemberPlanYear operationId: GetMemberPlanYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberPlanYearKey in: path description: MemberPlanYear Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPlanYearVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPlanYearVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPlanYearVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Plan Years summary: Update MemberPlanYear description: Updates a specific MemberPlanYear. operationId: UpdateMemberPlanYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberPlanYearKey in: path description: MemberPlanYear Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberPlanYear' text/json: schema: $ref: '#/components/schemas/MemberPlanYear' application/*+json: schema: $ref: '#/components/schemas/MemberPlanYear' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPlanYearVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPlanYearVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPlanYearVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Plan Years summary: Delete MemberPlanYear description: Deletes an MemberPlanYear operationId: DeleteMemberPlanYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberPlanYearKey in: path description: MemberPlanYear Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/plan-years-batch': put: tags: - Member Plan Years summary: Create or Update Batch MemberPlanYear description: 'Create or Update multiple MemberPlanYear at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberPlanYear parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberPlanYear' text/json: schema: type: array items: $ref: '#/components/schemas/MemberPlanYear' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberPlanYear' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/pre-exisiting-diagnostic-codes': post: tags: - Member Pre-existing Diagnostic Codes summary: Create MemberPreExDiag description: Creates a new MemberPreExDiag operationId: CreateMemberPreExDiag parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberPreExDiag' text/json: schema: $ref: '#/components/schemas/MemberPreExDiag' application/*+json: schema: $ref: '#/components/schemas/MemberPreExDiag' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPreExDiagVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPreExDiagVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPreExDiagVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Pre-existing Diagnostic Codes summary: List MemberPreExDiag description: Lists all MemberPreExDiag for the given subscriberID and memberSeq operationId: ListMemberPreExDiag parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPreExDiagListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPreExDiagListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPreExDiagListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/pre-exisiting-diagnostic-codes/{diagnosticCodeType}/{fromDiag}': get: tags: - Member Pre-existing Diagnostic Codes summary: Get MemberPreExDiag description: Gets MemberPreExDiag operationId: GetMemberPreExDiag parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: fromDiag in: path description: From Diag required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPreExDiagVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPreExDiagVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPreExDiagVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Pre-existing Diagnostic Codes summary: Update MemberPreExDiag description: Updates a specific MemberPreExDiag. operationId: UpdateMemberPreExDiag parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: fromDiag in: path description: From Diag required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberPreExDiag' text/json: schema: $ref: '#/components/schemas/MemberPreExDiag' application/*+json: schema: $ref: '#/components/schemas/MemberPreExDiag' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPreExDiagVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPreExDiagVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPreExDiagVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Pre-existing Diagnostic Codes summary: Delete MemberPreExDiag description: Deletes an MemberPreExDiag operationId: DeleteMemberPreExDiag parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: fromDiag in: path description: From Diag required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/pre-exisiting-diagnostic-codes-batch': put: tags: - Member Pre-existing Diagnostic Codes summary: Create or Update Batch MemberPreExDiag description: 'Create or Update multiple MemberPreExDiag at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberPreExDiag parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberPreExDiag' text/json: schema: type: array items: $ref: '#/components/schemas/MemberPreExDiag' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberPreExDiag' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{Subscriber_ID}/members/{Member_Seq}/pre-ex-disclosed-diags': post: tags: - Member PreEx Disclosed Diags summary: Create MemberPreExDisclosedDiag description: Creates a new MemberPreExDisclosedDiag operationId: CreateMemberPreExDisclosedDiag parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: Member_Seq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiag' text/json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiag' application/*+json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiag' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiagVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiagVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiagVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member PreEx Disclosed Diags summary: List MemberPreExDisclosedDiag description: Lists all MemberPreExDisclosedDiag for the given Subscriber_ID and Member_Seq operationId: ListMemberPreExDisclosedDiag parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: Member_Seq in: path description: Member Seq required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiagListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiagListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiagListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{Subscriber_ID}/members/{Member_Seq}/pre-ex-disclosed-diags/{MemberPreExDisclosedDiag_Key}': get: tags: - Member PreEx Disclosed Diags summary: Get MemberPreExDisclosedDiag description: Gets MemberPreExDisclosedDiag operationId: GetMemberPreExDisclosedDiag parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: Member_Seq in: path description: Member Seq required: true schema: type: string - name: MemberPreExDisclosedDiag_Key in: path description: MemberPreExDisclosedDiag Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiagVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiagVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiagVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member PreEx Disclosed Diags summary: Update MemberPreExDisclosedDiag description: Updates a specific MemberPreExDisclosedDiag. operationId: UpdateMemberPreExDisclosedDiag parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: Member_Seq in: path description: Member Seq required: true schema: type: string - name: MemberPreExDisclosedDiag_Key in: path description: MemberPreExDisclosedDiag Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiag' text/json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiag' application/*+json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiag' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiagVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiagVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPreExDisclosedDiagVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member PreEx Disclosed Diags summary: Delete MemberPreExDisclosedDiag description: Deletes an MemberPreExDisclosedDiag operationId: DeleteMemberPreExDisclosedDiag parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: Member_Seq in: path description: Member Seq required: true schema: type: string - name: MemberPreExDisclosedDiag_Key in: path description: MemberPreExDisclosedDiag Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{Subscriber_ID}/members/{Member_Seq}/pre-ex-disclosed-diags-batch': put: tags: - Member PreEx Disclosed Diags summary: Create or Update Batch MemberPreExDisclosedDiag description: 'Create or Update multiple MemberPreExDisclosedDiag at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberPreExDisclosedDiag parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: Member_Seq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberPreExDisclosedDiag' text/json: schema: type: array items: $ref: '#/components/schemas/MemberPreExDisclosedDiag' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberPreExDisclosedDiag' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/prior-accumulators': post: tags: - Member Prior Accumulators summary: Create MemberPriorAccum description: Creates a new MemberPriorAccum operationId: CreateMemberPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberPriorAccum' text/json: schema: $ref: '#/components/schemas/MemberPriorAccum' application/*+json: schema: $ref: '#/components/schemas/MemberPriorAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPriorAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPriorAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPriorAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Prior Accumulators summary: List MemberPriorAccum description: Lists all MemberPriorAccum for the given subscriberID and memberSeq operationId: ListMemberPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPriorAccumListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPriorAccumListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPriorAccumListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/prior-accumulators/{groupID}/{divisionID}/{planYear}/{planType}/{benefitCode}': get: tags: - Member Prior Accumulators summary: Get MemberPriorAccum description: Gets MemberPriorAccum operationId: GetMemberPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPriorAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPriorAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPriorAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Prior Accumulators summary: Update MemberPriorAccum description: Updates a specific MemberPriorAccum. operationId: UpdateMemberPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberPriorAccum' text/json: schema: $ref: '#/components/schemas/MemberPriorAccum' application/*+json: schema: $ref: '#/components/schemas/MemberPriorAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberPriorAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberPriorAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberPriorAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Prior Accumulators summary: Delete MemberPriorAccum description: Deletes an MemberPriorAccum operationId: DeleteMemberPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/prior-accumulators-batch': put: tags: - Member Prior Accumulators summary: Create or Update Batch MemberPriorAccum description: 'Create or Update multiple MemberPriorAccum at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberPriorAccum' text/json: schema: type: array items: $ref: '#/components/schemas/MemberPriorAccum' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberPriorAccum' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/providers': post: tags: - Member Providers summary: Create MemberProvider description: Creates a new MemberProvider operationId: CreateMemberProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberProvider' text/json: schema: $ref: '#/components/schemas/MemberProvider' application/*+json: schema: $ref: '#/components/schemas/MemberProvider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberProviderVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberProviderVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberProviderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Providers summary: List MemberProvider description: Lists all MemberProvider for the given subscriberID and memberSeq operationId: ListMemberProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberProviderListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberProviderListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberProviderListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/providers/{memberProviderKey}': get: tags: - Member Providers summary: Get MemberProvider description: Gets MemberProvider operationId: GetMemberProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberProviderKey in: path description: MemberProvider Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberProviderVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberProviderVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberProviderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Providers summary: Update MemberProvider description: Updates a specific MemberProvider. operationId: UpdateMemberProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberProviderKey in: path description: MemberProvider Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberProvider' text/json: schema: $ref: '#/components/schemas/MemberProvider' application/*+json: schema: $ref: '#/components/schemas/MemberProvider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberProviderVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberProviderVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberProviderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Providers summary: Delete MemberProvider description: Deletes an MemberProvider operationId: DeleteMemberProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberProviderKey in: path description: MemberProvider Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/providers-batch': put: tags: - Member Providers summary: Create or Update Batch MemberProvider description: 'Create or Update multiple MemberProvider at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberProvider' text/json: schema: type: array items: $ref: '#/components/schemas/MemberProvider' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberProvider' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/providers/{memberProviderKey}/alternates': post: tags: - Member Provider Alternates summary: Create MemberProviderAlternate description: Creates a new MemberProviderAlternate operationId: CreateMemberProviderAlternate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberProviderKey in: path description: MemberProvider Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberProviderAlternate' text/json: schema: $ref: '#/components/schemas/MemberProviderAlternate' application/*+json: schema: $ref: '#/components/schemas/MemberProviderAlternate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberProviderAlternateVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberProviderAlternateVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberProviderAlternateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Provider Alternates summary: List MemberProviderAlternate description: Lists all MemberProviderAlternate for the given memberProviderKey operationId: ListMemberProviderAlternate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberProviderKey in: path description: MemberProvider Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberProviderAlternateListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberProviderAlternateListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberProviderAlternateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/providers/{memberProviderKey}/alternates/{providerID}': get: tags: - Member Provider Alternates summary: Get MemberProviderAlternate description: Gets MemberProviderAlternate operationId: GetMemberProviderAlternate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberProviderKey in: path description: MemberProvider Key required: true schema: type: integer format: int32 - name: providerID in: path description: Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberProviderAlternateVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberProviderAlternateVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberProviderAlternateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Provider Alternates summary: Update MemberProviderAlternate description: Updates a specific MemberProviderAlternate. operationId: UpdateMemberProviderAlternate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberProviderKey in: path description: MemberProvider Key required: true schema: type: integer format: int32 - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberProviderAlternate' text/json: schema: $ref: '#/components/schemas/MemberProviderAlternate' application/*+json: schema: $ref: '#/components/schemas/MemberProviderAlternate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberProviderAlternateVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberProviderAlternateVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberProviderAlternateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Provider Alternates summary: Delete MemberProviderAlternate description: Deletes an MemberProviderAlternate operationId: DeleteMemberProviderAlternate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberProviderKey in: path description: MemberProvider Key required: true schema: type: integer format: int32 - name: providerID in: path description: Provider ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/providers/{memberProviderKey}/alternates-batch': put: tags: - Member Provider Alternates summary: Create or Update Batch MemberProviderAlternate description: 'Create or Update multiple MemberProviderAlternate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberProviderAlternate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberProviderKey in: path description: MemberProvider Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberProviderAlternate' text/json: schema: type: array items: $ref: '#/components/schemas/MemberProviderAlternate' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberProviderAlternate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members': post: tags: - Members summary: Create Members description: Creates a new Members operationId: CreateMembers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Members' text/json: schema: $ref: '#/components/schemas/Members' application/*+json: schema: $ref: '#/components/schemas/Members' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MembersVBAResponse' application/json: schema: $ref: '#/components/schemas/MembersVBAResponse' text/json: schema: $ref: '#/components/schemas/MembersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Members summary: List Members description: Lists all Members for the given subscriberID operationId: ListMembers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MembersListVBAResponse' application/json: schema: $ref: '#/components/schemas/MembersListVBAResponse' text/json: schema: $ref: '#/components/schemas/MembersListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}': get: tags: - Members summary: Get Members description: Gets Members operationId: GetMembers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MembersVBAResponse' application/json: schema: $ref: '#/components/schemas/MembersVBAResponse' text/json: schema: $ref: '#/components/schemas/MembersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Members summary: Update Members description: Updates a specific Members. operationId: UpdateMembers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Members' text/json: schema: $ref: '#/components/schemas/Members' application/*+json: schema: $ref: '#/components/schemas/Members' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MembersVBAResponse' application/json: schema: $ref: '#/components/schemas/MembersVBAResponse' text/json: schema: $ref: '#/components/schemas/MembersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Members summary: Delete Members description: Deletes an Members operationId: DeleteMembers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members-batch': put: tags: - Members summary: Create or Update Batch Members description: 'Create or Update multiple Members at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMembers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Members' text/json: schema: type: array items: $ref: '#/components/schemas/Members' application/*+json: schema: type: array items: $ref: '#/components/schemas/Members' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/member-disability-tax-summary/{taxYear}': get: tags: - Members summary: Get MembersDisabilityTaxSummary description: Retrieve the MembersDisabilityTaxSummary for the given year operationId: GetMembersDisabilityTaxSummary parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: taxYear in: path description: Tax Year required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_MembersDisabilityTaxSummaryVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_MembersDisabilityTaxSummaryVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_MembersDisabilityTaxSummaryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/taxes': post: tags: - Member Taxes summary: Create MemberTax description: Creates a new MemberTax operationId: CreateMemberTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberTax' text/json: schema: $ref: '#/components/schemas/MemberTax' application/*+json: schema: $ref: '#/components/schemas/MemberTax' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberTaxVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberTaxVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberTaxVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Taxes summary: List MemberTax description: Lists all MemberTax for the given subscriberID and memberSeq and memberTaxKey operationId: ListMemberTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberTaxListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberTaxListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberTaxListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/taxes/{memberTaxKey}': get: tags: - Member Taxes summary: Get MemberTax description: Gets MemberTax operationId: GetMemberTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberTaxKey in: path description: MemberTax Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberTaxVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberTaxVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberTaxVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Taxes summary: Update MemberTax description: Updates a specific MemberTax. operationId: UpdateMemberTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberTaxKey in: path description: MemberTax Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberTax' text/json: schema: $ref: '#/components/schemas/MemberTax' application/*+json: schema: $ref: '#/components/schemas/MemberTax' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberTaxVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberTaxVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberTaxVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Taxes summary: Delete MemberTax description: Deletes an MemberTax operationId: DeleteMemberTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberTaxKey in: path description: MemberTax Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/taxes-batch': put: tags: - Member Taxes summary: Create or Update Batch MemberTax description: 'Create or Update multiple MemberTax at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberTax' text/json: schema: type: array items: $ref: '#/components/schemas/MemberTax' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberTax' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/teeth': post: tags: - Member Tooth summary: Create MemberTooth description: Creates a new MemberTooth operationId: CreateMemberTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberTooth' text/json: schema: $ref: '#/components/schemas/MemberTooth' application/*+json: schema: $ref: '#/components/schemas/MemberTooth' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberToothVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberToothVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberToothVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Tooth summary: List MemberTooth description: Lists all MemberTooth for the given subscriberID and memberSeq operationId: ListMemberTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberToothListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberToothListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberToothListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/teeth/{memberToothKey}': get: tags: - Member Tooth summary: Get MemberTooth description: Gets MemberTooth operationId: GetMemberTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberToothKey in: path description: MemberTooth Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberToothVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberToothVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberToothVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Tooth summary: Update MemberTooth description: Updates a specific MemberTooth. operationId: UpdateMemberTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberToothKey in: path description: MemberTooth Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberTooth' text/json: schema: $ref: '#/components/schemas/MemberTooth' application/*+json: schema: $ref: '#/components/schemas/MemberTooth' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberToothVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberToothVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberToothVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Tooth summary: Delete MemberTooth description: Deletes an MemberTooth operationId: DeleteMemberTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: memberToothKey in: path description: MemberTooth Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/teeth-batch': put: tags: - Member Tooth summary: Create or Update Batch MemberTooth description: 'Create or Update multiple MemberTooth at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberTooth' text/json: schema: type: array items: $ref: '#/components/schemas/MemberTooth' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberTooth' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/teeth-ex-codes': post: tags: - Member Tooth Ex Codes summary: Create MemberToothExCode description: Creates a new MemberToothExCode operationId: CreateMemberToothExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberToothExCode' text/json: schema: $ref: '#/components/schemas/MemberToothExCode' application/*+json: schema: $ref: '#/components/schemas/MemberToothExCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberToothExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberToothExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberToothExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Tooth Ex Codes summary: List MemberToothExCode description: Lists all MemberToothExCode for the given subscriberID and memberSeq operationId: ListMemberToothExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberToothExCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberToothExCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberToothExCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/teeth-ex-codes/{toothNumber}': get: tags: - Member Tooth Ex Codes summary: Get MemberToothExCode description: Gets MemberToothExCode operationId: GetMemberToothExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: toothNumber in: path description: Tooth Number required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberToothExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberToothExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberToothExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Tooth Ex Codes summary: Update MemberToothExCode description: Updates a specific MemberToothExCode. operationId: UpdateMemberToothExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: toothNumber in: path description: Tooth Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberToothExCode' text/json: schema: $ref: '#/components/schemas/MemberToothExCode' application/*+json: schema: $ref: '#/components/schemas/MemberToothExCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberToothExCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberToothExCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberToothExCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Tooth Ex Codes summary: Delete MemberToothExCode description: Deletes an MemberToothExCode operationId: DeleteMemberToothExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: toothNumber in: path description: Tooth Number required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/teeth-ex-codes-batch': put: tags: - Member Tooth Ex Codes summary: Create or Update Batch MemberToothExCode description: 'Create or Update multiple MemberToothExCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberToothExCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberToothExCode' text/json: schema: type: array items: $ref: '#/components/schemas/MemberToothExCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberToothExCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/vba-plan-type-ids': post: tags: - Member VBA Plan Type IDs summary: Create MemberVBAPlanTypeID description: Creates a new MemberVBAPlanTypeID operationId: CreateMemberVBAPlanTypeID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeID' text/json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeID' application/*+json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeID' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberVBAPlanTypeIDVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeIDVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeIDVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member VBA Plan Type IDs summary: List MemberVBAPlanTypeID description: Lists all MemberVBAPlanTypeID for the given subscriberID and memberSeq operationId: ListMemberVBAPlanTypeID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberVBAPlanTypeIDListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeIDListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeIDListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/vba-plan-type-ids/{vBAPlanType}': get: tags: - Member VBA Plan Type IDs summary: Get MemberVBAPlanTypeID description: Gets MemberVBAPlanTypeID operationId: GetMemberVBAPlanTypeID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: vBAPlanType in: path description: VBA Plan Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberVBAPlanTypeIDVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeIDVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeIDVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member VBA Plan Type IDs summary: Update MemberVBAPlanTypeID description: Updates a specific MemberVBAPlanTypeID. operationId: UpdateMemberVBAPlanTypeID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: vBAPlanType in: path description: VBA Plan Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeID' text/json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeID' application/*+json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeID' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemberVBAPlanTypeIDVBAResponse' application/json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeIDVBAResponse' text/json: schema: $ref: '#/components/schemas/MemberVBAPlanTypeIDVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member VBA Plan Type IDs summary: Delete MemberVBAPlanTypeID description: Deletes an MemberVBAPlanTypeID operationId: DeleteMemberVBAPlanTypeID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: vBAPlanType in: path description: VBA Plan Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/vba-plan-type-ids-batch': put: tags: - Member VBA Plan Type IDs summary: Create or Update Batch MemberVBAPlanTypeID description: 'Create or Update multiple MemberVBAPlanTypeID at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemberVBAPlanTypeID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberVBAPlanTypeID' text/json: schema: type: array items: $ref: '#/components/schemas/MemberVBAPlanTypeID' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemberVBAPlanTypeID' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/groups/{groupID}/divisions/{divisionID}/enrollments': post: tags: - Member Enrollment Plans summary: Create MemEnrollmentPlan description: Creates a new MemEnrollmentPlan operationId: CreateMemEnrollmentPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MemEnrollmentPlan' text/json: schema: $ref: '#/components/schemas/MemEnrollmentPlan' application/*+json: schema: $ref: '#/components/schemas/MemEnrollmentPlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemEnrollmentPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/MemEnrollmentPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/MemEnrollmentPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Enrollment Plans summary: List MemEnrollmentPlan description: Lists all MemEnrollmentPlan for the given subscriberID and memberSeq and groupID and divisionID operationId: ListMemEnrollmentPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemEnrollmentPlanListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemEnrollmentPlanListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemEnrollmentPlanListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/groups/{groupID}/divisions/{divisionID}/enrollments/{groupCoverageStart}/{subStartDate}/plans/{planID}/{planStart}': get: tags: - Member Enrollment Plans summary: Get MemEnrollmentPlan description: Gets MemEnrollmentPlan operationId: GetMemEnrollmentPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: subStartDate in: path description: Sub Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemEnrollmentPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/MemEnrollmentPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/MemEnrollmentPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Enrollment Plans summary: Update MemEnrollmentPlan description: Updates a specific MemEnrollmentPlan. operationId: UpdateMemEnrollmentPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: subStartDate in: path description: Sub Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/MemEnrollmentPlan' text/json: schema: $ref: '#/components/schemas/MemEnrollmentPlan' application/*+json: schema: $ref: '#/components/schemas/MemEnrollmentPlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemEnrollmentPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/MemEnrollmentPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/MemEnrollmentPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Enrollment Plans summary: Delete MemEnrollmentPlan description: Deletes an MemEnrollmentPlan operationId: DeleteMemEnrollmentPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: subStartDate in: path description: Sub Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/groups/{groupID}/divisions/{divisionID}/enrollments-batch': put: tags: - Member Enrollment Plans summary: Create or Update Batch MemEnrollmentPlan description: 'Create or Update multiple MemEnrollmentPlan at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemEnrollmentPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemEnrollmentPlan' text/json: schema: type: array items: $ref: '#/components/schemas/MemEnrollmentPlan' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemEnrollmentPlan' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/groups/{groupID}/divisions/{divisionID}/enrollments/{groupCoverageStart}/{subStartDate}/plans/{planID}/{planStart}/riders': post: tags: - Member Enrollment Plan Rider summary: Create MemEnrollmentRider description: Creates a new MemEnrollmentRider operationId: CreateMemEnrollmentRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: subStartDate in: path description: Sub Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/MemEnrollmentRider' text/json: schema: $ref: '#/components/schemas/MemEnrollmentRider' application/*+json: schema: $ref: '#/components/schemas/MemEnrollmentRider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemEnrollmentRiderVBAResponse' application/json: schema: $ref: '#/components/schemas/MemEnrollmentRiderVBAResponse' text/json: schema: $ref: '#/components/schemas/MemEnrollmentRiderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Member Enrollment Plan Rider summary: List MemEnrollmentRider description: Lists all MemEnrollmentRider for the given subscriberID and memberSeq and groupID and divisionID and groupCoverageStart and subStartDate and planID and planStart operationId: ListMemEnrollmentRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: subStartDate in: path description: Sub Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemEnrollmentRiderListVBAResponse' application/json: schema: $ref: '#/components/schemas/MemEnrollmentRiderListVBAResponse' text/json: schema: $ref: '#/components/schemas/MemEnrollmentRiderListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/groups/{groupID}/divisions/{divisionID}/enrollments/{groupCoverageStart}/{subStartDate}/plans/{planID}/{planStart}/riders/{benefitCode}/{fromDate}': get: tags: - Member Enrollment Plan Rider summary: Get MemEnrollmentRider description: Gets MemEnrollmentRider operationId: GetMemEnrollmentRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: subStartDate in: path description: Sub Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: fromDate in: path description: From Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemEnrollmentRiderVBAResponse' application/json: schema: $ref: '#/components/schemas/MemEnrollmentRiderVBAResponse' text/json: schema: $ref: '#/components/schemas/MemEnrollmentRiderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Member Enrollment Plan Rider summary: Update MemEnrollmentRider description: Updates a specific MemEnrollmentRider. operationId: UpdateMemEnrollmentRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: subStartDate in: path description: Sub Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: fromDate in: path description: From Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/MemEnrollmentRider' text/json: schema: $ref: '#/components/schemas/MemEnrollmentRider' application/*+json: schema: $ref: '#/components/schemas/MemEnrollmentRider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MemEnrollmentRiderVBAResponse' application/json: schema: $ref: '#/components/schemas/MemEnrollmentRiderVBAResponse' text/json: schema: $ref: '#/components/schemas/MemEnrollmentRiderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Member Enrollment Plan Rider summary: Delete MemEnrollmentRider description: Deletes an MemEnrollmentRider operationId: DeleteMemEnrollmentRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: subStartDate in: path description: Sub Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: fromDate in: path description: From Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/members/{memberSeq}/groups/{groupID}/divisions/{divisionID}/enrollments/{groupCoverageStart}/{subStartDate}/plans/{planID}/{planStart}/riders-batch': put: tags: - Member Enrollment Plan Rider summary: Create or Update Batch MemEnrollmentRider description: 'Create or Update multiple MemEnrollmentRider at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchMemEnrollmentRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: subStartDate in: path description: Sub Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MemEnrollmentRider' text/json: schema: type: array items: $ref: '#/components/schemas/MemEnrollmentRider' application/*+json: schema: type: array items: $ref: '#/components/schemas/MemEnrollmentRider' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /mfa-setup: post: tags: - Multi-Factor Auth summary: Request MFA Device Setup description: Generates a SecretCode and a QR code. Either can be used for setting up multi-factor authentication (MFA) with an authenticator app. operationId: MFADeviceSetup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MFADeviceSetupRequest' text/json: schema: $ref: '#/components/schemas/MFADeviceSetupRequest' application/*+json: schema: $ref: '#/components/schemas/MFADeviceSetupRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MFADeviceSetupResponseVBAResponse' application/json: schema: $ref: '#/components/schemas/MFADeviceSetupResponseVBAResponse' text/json: schema: $ref: '#/components/schemas/MFADeviceSetupResponseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /mfa-verify-setup: post: tags: - Multi-Factor Auth summary: Verify an MFA Device Setup description: Verifies the registration of a multi-factor authentication (MFA) device for the user by verifying the software token and associating it with the user's account. operationId: VerifyMFADeviceSetup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VerifyMFADeviceSetupRequest' text/json: schema: $ref: '#/components/schemas/VerifyMFADeviceSetupRequest' application/*+json: schema: $ref: '#/components/schemas/VerifyMFADeviceSetupRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VerifyMFADeviceSetupResponseVBAResponse' application/json: schema: $ref: '#/components/schemas/VerifyMFADeviceSetupResponseVBAResponse' text/json: schema: $ref: '#/components/schemas/VerifyMFADeviceSetupResponseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /mfa-disable: post: tags: - Multi-Factor Auth summary: Disable MFA description: 'Disables MFA (Multi-Factor Authentication) for a specified user. If a MFA software token has previously been registered, it is not destroyed, just disabled.' operationId: DisableMFASetup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisableMFASetupRequest' text/json: schema: $ref: '#/components/schemas/DisableMFASetupRequest' application/*+json: schema: $ref: '#/components/schemas/DisableMFASetupRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /mfa-enable: post: tags: - Multi-Factor Auth summary: Enable MFA description: 'Enables MFA (Multi-Factor Authentication) for a specified user. If an MFA software token has previously been registered, it will be re-enabled.' operationId: EnableMFASetup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableMFASetupRequest' text/json: schema: $ref: '#/components/schemas/EnableMFASetupRequest' application/*+json: schema: $ref: '#/components/schemas/EnableMFASetupRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /mfa-submit-code: post: tags: - User summary: Submit MFA Code description: Submits a multi-factor authentication (MFA) code provided by the user and completes the authentication process. operationId: SubmitMFACode parameters: - name: vbasoftware-client-id in: header description: Client ID required: true schema: type: string - name: vbasoftware-client-code in: header description: Client Code required: true schema: type: string - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitMFACodeRequest' text/json: schema: $ref: '#/components/schemas/SubmitMFACodeRequest' application/*+json: schema: $ref: '#/components/schemas/SubmitMFACodeRequest' required: true responses: '202': description: Accepted content: text/plain: schema: $ref: '#/components/schemas/UserAuthenticationResponseVBAResponse' application/json: schema: $ref: '#/components/schemas/UserAuthenticationResponseVBAResponse' text/json: schema: $ref: '#/components/schemas/UserAuthenticationResponseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] /mfa-enable-globally: post: tags: - Multi-Factor Auth summary: Enable MFA for all Users description: 'Enables MFA (Multi-Factor Authentication) for all users in the organization. If an MFA software token has previously been registered, it will be re-enabled.' operationId: EnableMFAGlobally parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /mfa-disable-globally: post: tags: - Multi-Factor Auth summary: Disable MFA for all Users description: 'Disables MFA (Multi-Factor Authentication) for all users in the organization. If an MFA software token has previously been registered, it will be set to inactive.' operationId: DisableMFAGlobally parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /mfa-status: get: tags: - Multi-Factor Auth summary: Get Current MFA Status description: Fetches the current multi-factor authentication (MFA) status for the logged-in user. operationId: GetMFAStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BooleanVBAResponse' application/json: schema: $ref: '#/components/schemas/BooleanVBAResponse' text/json: schema: $ref: '#/components/schemas/BooleanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /modifiers: post: tags: - Modifiers summary: Create Modifier description: Creates a new Modifier operationId: CreateModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Modifier' text/json: schema: $ref: '#/components/schemas/Modifier' application/*+json: schema: $ref: '#/components/schemas/Modifier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/ModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/ModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Modifiers summary: List Modifier description: Lists all Modifier operationId: ListModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ModifierListVBAResponse' application/json: schema: $ref: '#/components/schemas/ModifierListVBAResponse' text/json: schema: $ref: '#/components/schemas/ModifierListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/modifiers/{modifierCode}': get: tags: - Modifiers summary: Get Modifier description: Gets Modifier operationId: GetModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: modifierCode in: path description: Modifier Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/ModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/ModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Modifiers summary: Update Modifier description: Updates a specific Modifier. operationId: UpdateModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: modifierCode in: path description: Modifier Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Modifier' text/json: schema: $ref: '#/components/schemas/Modifier' application/*+json: schema: $ref: '#/components/schemas/Modifier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/ModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/ModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Modifiers summary: Delete Modifier description: Deletes an Modifier operationId: DeleteModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: modifierCode in: path description: Modifier Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /modifiers-batch: put: tags: - Modifiers summary: Create or Update Batch Modifier description: 'Create or Update multiple Modifier at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Modifier' text/json: schema: type: array items: $ref: '#/components/schemas/Modifier' application/*+json: schema: type: array items: $ref: '#/components/schemas/Modifier' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/networks/{networkID}/modifiers': post: tags: - Network Modifiers summary: Create NetworkModifier description: Creates a new NetworkModifier operationId: CreateNetworkModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkModifier' text/json: schema: $ref: '#/components/schemas/NetworkModifier' application/*+json: schema: $ref: '#/components/schemas/NetworkModifier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Network Modifiers summary: List NetworkModifier description: Lists all NetworkModifier for the given networkID operationId: ListNetworkModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkModifierListVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkModifierListVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkModifierListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/networks/{networkID}/modifiers/{modifier}/{effectiveDate}': get: tags: - Network Modifiers summary: Get NetworkModifier description: Gets NetworkModifier operationId: GetNetworkModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: modifier in: path description: Modifier required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Network Modifiers summary: Update NetworkModifier description: Updates a specific NetworkModifier. operationId: UpdateNetworkModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: modifier in: path description: Modifier required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkModifier' text/json: schema: $ref: '#/components/schemas/NetworkModifier' application/*+json: schema: $ref: '#/components/schemas/NetworkModifier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Network Modifiers summary: Delete NetworkModifier description: Deletes an NetworkModifier operationId: DeleteNetworkModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: modifier in: path description: Modifier required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/networks/{networkID}/modifiers-batch': put: tags: - Network Modifiers summary: Create or Update Batch NetworkModifier description: 'Create or Update multiple NetworkModifier at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNetworkModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkModifier' text/json: schema: type: array items: $ref: '#/components/schemas/NetworkModifier' application/*+json: schema: type: array items: $ref: '#/components/schemas/NetworkModifier' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/networks/{networkID}/practice-types': post: tags: - Network Practice Types summary: Create NetworkPracticeType description: Creates a new NetworkPracticeType operationId: CreateNetworkPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkPracticeType' text/json: schema: $ref: '#/components/schemas/NetworkPracticeType' application/*+json: schema: $ref: '#/components/schemas/NetworkPracticeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkPracticeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkPracticeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkPracticeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Network Practice Types summary: List NetworkPracticeType description: Lists all NetworkPracticeType for the given networkID operationId: ListNetworkPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkPracticeTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkPracticeTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkPracticeTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/networks/{networkID}/practice-types/{practiceType}/{effectiveDate}': get: tags: - Network Practice Types summary: Get NetworkPracticeType description: Gets NetworkPracticeType operationId: GetNetworkPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: practiceType in: path description: Practice Type required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkPracticeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkPracticeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkPracticeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Network Practice Types summary: Update NetworkPracticeType description: Updates a specific NetworkPracticeType. operationId: UpdateNetworkPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: practiceType in: path description: Practice Type required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkPracticeType' text/json: schema: $ref: '#/components/schemas/NetworkPracticeType' application/*+json: schema: $ref: '#/components/schemas/NetworkPracticeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkPracticeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkPracticeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkPracticeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Network Practice Types summary: Delete NetworkPracticeType description: Deletes an NetworkPracticeType operationId: DeleteNetworkPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: practiceType in: path description: Practice Type required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/networks/{networkID}/practice-types-batch': put: tags: - Network Practice Types summary: Create or Update Batch NetworkPracticeType description: 'Create or Update multiple NetworkPracticeType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNetworkPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkPracticeType' text/json: schema: type: array items: $ref: '#/components/schemas/NetworkPracticeType' application/*+json: schema: type: array items: $ref: '#/components/schemas/NetworkPracticeType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/networks/{networkID}/procedure-clusters': post: tags: - Network Procedure Clusters summary: Create NetworkProcedureCluster description: Creates a new NetworkProcedureCluster operationId: CreateNetworkProcedureCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkProcedureCluster' text/json: schema: $ref: '#/components/schemas/NetworkProcedureCluster' application/*+json: schema: $ref: '#/components/schemas/NetworkProcedureCluster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProcedureClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProcedureClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProcedureClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Network Procedure Clusters summary: List NetworkProcedureCluster description: Lists all NetworkProcedureCluster for the given networkID operationId: ListNetworkProcedureCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProcedureClusterListVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProcedureClusterListVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProcedureClusterListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/networks/{networkID}/procedure-clusters/{procedureCluster}/{effectiveDate}': get: tags: - Network Procedure Clusters summary: Get NetworkProcedureCluster description: Gets NetworkProcedureCluster operationId: GetNetworkProcedureCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: procedureCluster in: path description: Procedure Cluster required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProcedureClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProcedureClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProcedureClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Network Procedure Clusters summary: Update NetworkProcedureCluster description: Updates a specific NetworkProcedureCluster. operationId: UpdateNetworkProcedureCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: procedureCluster in: path description: Procedure Cluster required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkProcedureCluster' text/json: schema: $ref: '#/components/schemas/NetworkProcedureCluster' application/*+json: schema: $ref: '#/components/schemas/NetworkProcedureCluster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProcedureClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProcedureClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProcedureClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Network Procedure Clusters summary: Delete NetworkProcedureCluster description: Deletes an NetworkProcedureCluster operationId: DeleteNetworkProcedureCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: procedureCluster in: path description: Procedure Cluster required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/networks/{networkID}/procedure-clusters-batch': put: tags: - Network Procedure Clusters summary: Create or Update Batch NetworkProcedureCluster description: 'Create or Update multiple NetworkProcedureCluster at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNetworkProcedureCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkProcedureCluster' text/json: schema: type: array items: $ref: '#/components/schemas/NetworkProcedureCluster' application/*+json: schema: type: array items: $ref: '#/components/schemas/NetworkProcedureCluster' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /network-profiles: post: tags: - Network Profiles summary: Create NetworkProfile description: Creates a new NetworkProfile operationId: CreateNetworkProfile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkProfile' text/json: schema: $ref: '#/components/schemas/NetworkProfile' application/*+json: schema: $ref: '#/components/schemas/NetworkProfile' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProfileVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProfileVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProfileVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Network Profiles summary: List NetworkProfile description: Lists all NetworkProfile operationId: ListNetworkProfile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProfileListVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProfileListVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProfileListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/network-profiles/{Profile_ID}': get: tags: - Network Profiles summary: Get NetworkProfile description: Gets NetworkProfile operationId: GetNetworkProfile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Profile_ID in: path description: Profile ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProfileVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProfileVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProfileVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Network Profiles summary: Update NetworkProfile description: Updates a specific NetworkProfile. operationId: UpdateNetworkProfile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Profile_ID in: path description: Profile ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkProfile' text/json: schema: $ref: '#/components/schemas/NetworkProfile' application/*+json: schema: $ref: '#/components/schemas/NetworkProfile' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProfileVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProfileVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProfileVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Network Profiles summary: Delete NetworkProfile description: Deletes an NetworkProfile operationId: DeleteNetworkProfile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Profile_ID in: path description: Profile ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /network-profiles-batch: put: tags: - Network Profiles summary: Create or Update Batch NetworkProfile description: 'Create or Update multiple NetworkProfile at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNetworkProfile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkProfile' text/json: schema: type: array items: $ref: '#/components/schemas/NetworkProfile' application/*+json: schema: type: array items: $ref: '#/components/schemas/NetworkProfile' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /network-profile-assignments: post: tags: - Network Profile Assignments summary: Create NetworkProfileAssign description: Creates a new NetworkProfileAssign operationId: CreateNetworkProfileAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkProfileAssign' text/json: schema: $ref: '#/components/schemas/NetworkProfileAssign' application/*+json: schema: $ref: '#/components/schemas/NetworkProfileAssign' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProfileAssignVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProfileAssignVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProfileAssignVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/network-profiles/{Profile_ID}/assignments': get: tags: - Network Profile Assignments summary: List NetworkProfileAssign description: Lists all NetworkProfileAssign for the given Profile_ID operationId: ListNetworkProfileAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Profile_ID in: path description: Profile ID required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProfileAssignListVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProfileAssignListVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProfileAssignListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/network-profiles/{Profile_ID}/types/{Assign_Type}/assignments/{Assign_ID}/effective/{Effective_Date}': get: tags: - Network Profile Assignments summary: Get NetworkProfileAssign description: Gets NetworkProfileAssign operationId: GetNetworkProfileAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Profile_ID in: path description: Profile ID required: true schema: type: string - name: Assign_Type in: path description: Assign Type required: true schema: type: string - name: Assign_ID in: path description: Assign ID required: true schema: type: string - name: Effective_Date in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProfileAssignVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProfileAssignVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProfileAssignVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Network Profile Assignments summary: Update NetworkProfileAssign description: Updates a specific NetworkProfileAssign. operationId: UpdateNetworkProfileAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Profile_ID in: path description: Profile ID required: true schema: type: string - name: Assign_Type in: path description: Assign Type required: true schema: type: string - name: Assign_ID in: path description: Assign ID required: true schema: type: string - name: Effective_Date in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkProfileAssign' text/json: schema: $ref: '#/components/schemas/NetworkProfileAssign' application/*+json: schema: $ref: '#/components/schemas/NetworkProfileAssign' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProfileAssignVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProfileAssignVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProfileAssignVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Network Profile Assignments summary: Delete NetworkProfileAssign description: Deletes an NetworkProfileAssign operationId: DeleteNetworkProfileAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Profile_ID in: path description: Profile ID required: true schema: type: string - name: Assign_Type in: path description: Assign Type required: true schema: type: string - name: Assign_ID in: path description: Assign ID required: true schema: type: string - name: Effective_Date in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /network-profile-assignments-batch: put: tags: - Network Profile Assignments summary: Create or Update Batch NetworkProfileAssign description: 'Create or Update multiple NetworkProfileAssign at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNetworkProfileAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkProfileAssign' text/json: schema: type: array items: $ref: '#/components/schemas/NetworkProfileAssign' application/*+json: schema: type: array items: $ref: '#/components/schemas/NetworkProfileAssign' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /network-profile-assign-types: get: tags: - Network Profile Assignments summary: List Assign Types description: List Assign Types operationId: ListAssignType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /network-profile-networks: post: tags: - Network Profile Networks summary: Create NetworkProfileNetwork description: Creates a new NetworkProfileNetwork operationId: CreateNetworkProfileNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkProfileNetwork' text/json: schema: $ref: '#/components/schemas/NetworkProfileNetwork' application/*+json: schema: $ref: '#/components/schemas/NetworkProfileNetwork' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProfileNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProfileNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProfileNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/network-profiles/{Profile_ID}/networks': get: tags: - Network Profile Networks summary: List NetworkProfileNetwork description: Lists all NetworkProfileNetwork for the given Profile_ID operationId: ListNetworkProfileNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Profile_ID in: path description: Profile ID required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProfileNetworkListVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProfileNetworkListVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProfileNetworkListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/network-profiles/{Profile_ID}/networks/{Network_ID}/effective/{Eff_Date}': get: tags: - Network Profile Networks summary: Get NetworkProfileNetwork description: Gets NetworkProfileNetwork operationId: GetNetworkProfileNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Profile_ID in: path description: Profile ID required: true schema: type: string - name: Network_ID in: path description: Network ID required: true schema: type: string - name: Eff_Date in: path description: Eff Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProfileNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProfileNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProfileNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Network Profile Networks summary: Update NetworkProfileNetwork description: Updates a specific NetworkProfileNetwork. operationId: UpdateNetworkProfileNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Profile_ID in: path description: Profile ID required: true schema: type: string - name: Network_ID in: path description: Network ID required: true schema: type: string - name: Eff_Date in: path description: Eff Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkProfileNetwork' text/json: schema: $ref: '#/components/schemas/NetworkProfileNetwork' application/*+json: schema: $ref: '#/components/schemas/NetworkProfileNetwork' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkProfileNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkProfileNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkProfileNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Network Profile Networks summary: Delete NetworkProfileNetwork description: Deletes an NetworkProfileNetwork operationId: DeleteNetworkProfileNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Profile_ID in: path description: Profile ID required: true schema: type: string - name: Network_ID in: path description: Network ID required: true schema: type: string - name: Eff_Date in: path description: Eff Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /network-profile-networks-batch: put: tags: - Network Profile Networks summary: Create or Update Batch NetworkProfileNetwork description: 'Create or Update multiple NetworkProfileNetwork at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNetworkProfileNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkProfileNetwork' text/json: schema: type: array items: $ref: '#/components/schemas/NetworkProfileNetwork' application/*+json: schema: type: array items: $ref: '#/components/schemas/NetworkProfileNetwork' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /networks: post: tags: - Networks summary: Create Network description: Creates a new Network operationId: CreateNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Networks' text/json: schema: $ref: '#/components/schemas/Networks' application/*+json: schema: $ref: '#/components/schemas/Networks' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworksVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworksVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworksVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Networks summary: List Networks description: List all available Networks operationId: ListNetworks parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworksListVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworksListVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworksListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/networks/{networkID}': get: tags: - Networks summary: Get Network description: Gets a specific Network operationId: GetNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworksVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworksVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworksVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Networks summary: Update Network description: Updates a specific Network operationId: UpdateNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: NetworkID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Networks' text/json: schema: $ref: '#/components/schemas/Networks' application/*+json: schema: $ref: '#/components/schemas/Networks' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworksVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworksVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworksVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Networks summary: Delete Network description: Deletes a specific Network operationId: DeleteNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkID in: path description: NetworkID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /networks-batch: put: tags: - Networks summary: Create or Update Batch Network description: Creates or Updates multiple Networks operationId: CreateOrUpdateBatchNetworks parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Networks' text/json: schema: type: array items: $ref: '#/components/schemas/Networks' application/*+json: schema: type: array items: $ref: '#/components/schemas/Networks' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /network-types: post: tags: - Network Types summary: Create NetworkType description: Creates a new NetworkType operationId: CreateNetworkType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkType' text/json: schema: $ref: '#/components/schemas/NetworkType' application/*+json: schema: $ref: '#/components/schemas/NetworkType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Network Types summary: List NetworkType description: Lists all NetworkType operationId: ListNetworkType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/network-types/{networkType}': get: tags: - Network Types summary: Get NetworkType description: Gets NetworkType operationId: GetNetworkType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkType in: path description: Network Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Network Types summary: Update NetworkType description: Updates a specific NetworkType. operationId: UpdateNetworkType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkType in: path description: Network Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkType' text/json: schema: $ref: '#/components/schemas/NetworkType' application/*+json: schema: $ref: '#/components/schemas/NetworkType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NetworkTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/NetworkTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/NetworkTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Network Types summary: Delete NetworkType description: Deletes an NetworkType operationId: DeleteNetworkType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: networkType in: path description: Network Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /network-types-batch: put: tags: - Network Types summary: Create or Update Batch NetworkType description: 'Create or Update multiple NetworkType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNetworkType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkType' text/json: schema: type: array items: $ref: '#/components/schemas/NetworkType' application/*+json: schema: type: array items: $ref: '#/components/schemas/NetworkType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-attachments: post: tags: - Note Attachments summary: Create NoteAttachment description: Creates a new NoteAttachment operationId: CreateNoteAttachment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteAttachment' text/json: schema: $ref: '#/components/schemas/NoteAttachment' application/*+json: schema: $ref: '#/components/schemas/NoteAttachment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteAttachmentVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteAttachmentVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteAttachmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-data/{noteKey}/note-attachments': get: tags: - Note Attachments summary: List NoteAttachment description: Lists all NoteAttachment for the given noteKey operationId: ListNoteAttachment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteKey in: path description: Note Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteAttachmentListVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteAttachmentListVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteAttachmentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-attachments/{attachmentKey}': get: tags: - Note Attachments summary: Get NoteAttachment description: Gets NoteAttachment operationId: GetNoteAttachment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: attachmentKey in: path description: Attachment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteAttachmentVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteAttachmentVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteAttachmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Note Attachments summary: Update NoteAttachment description: Updates a specific NoteAttachment. operationId: UpdateNoteAttachment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: attachmentKey in: path description: Attachment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteAttachment' text/json: schema: $ref: '#/components/schemas/NoteAttachment' application/*+json: schema: $ref: '#/components/schemas/NoteAttachment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteAttachmentVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteAttachmentVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteAttachmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Note Attachments summary: Delete NoteAttachment description: Deletes an NoteAttachment operationId: DeleteNoteAttachment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: attachmentKey in: path description: Attachment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-attachments-batch: put: tags: - Note Attachments summary: Create or Update Batch NoteAttachment description: 'Create or Update multiple NoteAttachment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNoteAttachment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NoteAttachment' text/json: schema: type: array items: $ref: '#/components/schemas/NoteAttachment' application/*+json: schema: type: array items: $ref: '#/components/schemas/NoteAttachment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-categories: post: tags: - Note Categories summary: Create NoteCategory description: Creates a new NoteCategory operationId: CreateNoteCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteCategory' text/json: schema: $ref: '#/components/schemas/NoteCategory' application/*+json: schema: $ref: '#/components/schemas/NoteCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Note Categories summary: List NoteCategory description: 'Lists all NoteCategory ' operationId: ListNoteCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-categories/{noteCategory}': get: tags: - Note Categories summary: Get NoteCategory description: Gets NoteCategory operationId: GetNoteCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteCategory in: path description: Note Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Note Categories summary: Update NoteCategory description: Updates a specific NoteCategory. operationId: UpdateNoteCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteCategory in: path description: Note Category required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteCategory' text/json: schema: $ref: '#/components/schemas/NoteCategory' application/*+json: schema: $ref: '#/components/schemas/NoteCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Note Categories summary: Delete NoteCategory description: Deletes an NoteCategory operationId: DeleteNoteCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteCategory in: path description: Note Category required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-categories-batch: put: tags: - Note Categories summary: Create or Update Batch NoteCategory description: 'Create or Update multiple NoteCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNoteCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NoteCategory' text/json: schema: type: array items: $ref: '#/components/schemas/NoteCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/NoteCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-categories/{noteCategory}/note-types/{noteType}': post: tags: - Note Category Types summary: Create NoteCategoryType description: Creates a new NoteCategoryType operationId: CreateNoteCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteCategory in: path description: Note Category required: true schema: type: string - name: noteType in: path description: Note Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteCategoryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteCategoryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteCategoryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Note Category Types summary: Get NoteCategoryType description: Gets NoteCategoryType operationId: GetNoteCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteCategory in: path description: Note Category required: true schema: type: string - name: noteType in: path description: Note Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteCategoryTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteCategoryTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteCategoryTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Note Category Types summary: Delete NoteCategoryType description: Deletes an NoteCategoryType operationId: DeleteNoteCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteCategory in: path description: Note Category required: true schema: type: string - name: noteType in: path description: Note Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-categories/{noteCategory}/note-types': get: tags: - Note Category Types summary: List NoteCategoryType description: Lists all NoteCategoryType noteCategory operationId: ListNoteCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteCategory in: path description: Note Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteCategoryTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteCategoryTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteCategoryTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-categories/{noteCategory}/note-types-batch': put: tags: - Note Category Types summary: Create multiple NoteCategoryType description: 'Create multiple NoteCategoryType at once. If the entity exists, an error message will be returned. If the entity does not exist, it will be created.' operationId: UpdateBatchNoteCategoryType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteCategory in: path description: Note Category required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NoteCategoryType' text/json: schema: type: array items: $ref: '#/components/schemas/NoteCategoryType' application/*+json: schema: type: array items: $ref: '#/components/schemas/NoteCategoryType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-data: post: tags: - Note Data summary: Create NoteData description: Creates a new NoteData operationId: CreateNoteData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteData' text/json: schema: $ref: '#/components/schemas/NoteData' application/*+json: schema: $ref: '#/components/schemas/NoteData' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteDataVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteDataVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteDataVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Note Data summary: List NoteData by Source description: "List of Notes based on a specific source\r\n Expectations of Category compared to what is in the source values\r\n\r\n AUTH\r\n @SourceColumn1 = auth_number\r\n\r\n CALL\r\n @SourceColumn1 = call_key\r\n\r\n CASE\r\n @SourceColumn1 = case_key\r\n\r\n CLAIM\r\n @SourceColumn1 = batch_number\r\n @SourceColumn2 = batch_claim\r\n\r\n CLMBTCH ** NO REFS **\r\n @SourceColumn1 = batch_number\r\n\r\n COMMAGEN ** NO REFS **\r\n @SourceColumn1 = commissionagency_key\r\n\r\n COMMREP ** NO REFS **\r\n @SourceColumn1 = commissionrep_key\r\n\r\n CORTRACK ** NO REFS **\r\n @SourceColumn1 = reporttrack_key\r\n\r\n FEESCHED ** NO REFS **\r\n @SourceColumn1 = fee_sched\r\n\r\n GRIEV\r\n @SourceColumn1 = grievance_key\r\n\r\n GROUP\r\n @SourceColumn1 = group_id\r\n\r\n GROUPDIV\r\n @SourceColumn1 = group_id\r\n @SourceColumn2 = division_id\r\n\r\n GRPCLASS\r\n @SourceColumn1 = group_id\r\n\r\n GWREQ ** NO REFS **\r\n @SourceColumn1 = request_key\r\n\r\n INTRFACE ** NO REFS **\r\n @SourceColumn1 = vbainterface_key\r\n\r\n INVHDR ** NO REFS **\r\n @SourceColumn1 = invoice_key\r\n\r\n MEMBER\r\n @SourceColumn1 = subscriber_id\r\n @SourceColumn2 = member_seq\r\n\r\n NETWORK ** NO REFS **\r\n @SourceColumn1 = network_id\r\n\r\n NOTE ** NO REFS **\r\n @SourceColumn1 = note_key\r\n\r\n PAYEE ** NO REFS **\r\n @SourceColumn1 = payee_id\r\n\r\n PAYOR ** NO REFS **\r\n @SourceColumn1 = payor_id\r\n\r\n PBENMAX\r\n @SourceColumn1 = plan_id\r\n @SourceColumn2 = benefit_code\r\n @SourceColumn3 = max_id\r\n\r\n PLAN ** NO REFS **\r\n @SourceColumn1 = plan_id\r\n\r\n PLANLVL ** NO REFS **\r\n @SourceColumn1 = planbenefitlevel_key\r\n\r\n PROV ** NO REFS **\r\n @SourceColumn1 = provider_id\r\n\r\n PROVCRED\r\n @SourceColumn1 = providercred_key\r\n\r\n REINS\r\n @SourceColumn1 = reinscontract_key\r\n\r\n REINSTRN\r\n @SourceColumn1 = reinscontracttrans_key\r\n\r\n SUB\r\n @SourceColumn1 = subscriber_id\r\n " operationId: ListNotesBySource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteCategory in: query description: Note_Category required: true schema: type: string - name: columnName1 in: query description: Column_Name1 required: true schema: type: string - name: keyValue1 in: query description: Key_Value1 required: true schema: type: string - name: columnName2 in: query description: Column_Name2 schema: type: string - name: keyValue2 in: query description: Key_Value2 schema: type: string - name: columnName3 in: query description: Column_Name3 schema: type: string - name: keyValue3 in: query description: Key_Value3 schema: type: string - name: columnName4 in: query description: Column_Name4 schema: type: string - name: keyValue4 in: query description: Key_Value4 schema: type: string - name: columnName5 in: query description: Column_Name5 schema: type: string - name: keyValue5 in: query description: Key_Value5 schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteDataListVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteDataListVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteDataListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-data/{noteKey}': get: tags: - Note Data summary: Get NoteData description: Gets NoteData operationId: GetNoteData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteKey in: path description: Note Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteDataVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteDataVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteDataVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Note Data summary: Update NoteData description: Updates a specific NoteData. operationId: UpdateNoteData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteKey in: path description: Note Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteData' text/json: schema: $ref: '#/components/schemas/NoteData' application/*+json: schema: $ref: '#/components/schemas/NoteData' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteDataVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteDataVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteDataVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Note Data summary: Delete NoteData description: Deletes an NoteData operationId: DeleteNoteData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteKey in: path description: Note Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-data-batch: put: tags: - Note Data summary: Create or Update Batch NoteData description: 'Create or Update multiple NoteData at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNoteData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NoteData' text/json: schema: type: array items: $ref: '#/components/schemas/NoteData' application/*+json: schema: type: array items: $ref: '#/components/schemas/NoteData' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-attachment-location/{noteCategory}': get: tags: - Note Data summary: Get Note Attachment Location description: Gets Note Attachment Location operationId: GetNoteAttachmentLocation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteCategory in: path description: Note Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-priorities: post: tags: - Note Priorities summary: Create NotePriority description: Creates a new NotePriority operationId: CreateNotePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NotePriority' text/json: schema: $ref: '#/components/schemas/NotePriority' application/*+json: schema: $ref: '#/components/schemas/NotePriority' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NotePriorityVBAResponse' application/json: schema: $ref: '#/components/schemas/NotePriorityVBAResponse' text/json: schema: $ref: '#/components/schemas/NotePriorityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Note Priorities summary: List NotePriority description: Lists all NotePriority operationId: ListNotePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NotePriorityListVBAResponse' application/json: schema: $ref: '#/components/schemas/NotePriorityListVBAResponse' text/json: schema: $ref: '#/components/schemas/NotePriorityListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-priorities/{notePriority}': get: tags: - Note Priorities summary: Get NotePriority description: Gets NotePriority operationId: GetNotePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: notePriority in: path description: Note Priority required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NotePriorityVBAResponse' application/json: schema: $ref: '#/components/schemas/NotePriorityVBAResponse' text/json: schema: $ref: '#/components/schemas/NotePriorityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Note Priorities summary: Update NotePriority description: Updates a specific NotePriority. operationId: UpdateNotePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: notePriority in: path description: Note Priority required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NotePriority' text/json: schema: $ref: '#/components/schemas/NotePriority' application/*+json: schema: $ref: '#/components/schemas/NotePriority' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NotePriorityVBAResponse' application/json: schema: $ref: '#/components/schemas/NotePriorityVBAResponse' text/json: schema: $ref: '#/components/schemas/NotePriorityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Note Priorities summary: Delete NotePriority description: Deletes an NotePriority operationId: DeleteNotePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: notePriority in: path description: Note Priority required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-priorities-batch: put: tags: - Note Priorities summary: Create or Update Batch NotePriority description: 'Create or Update multiple NotePriority at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNotePriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NotePriority' text/json: schema: type: array items: $ref: '#/components/schemas/NotePriority' application/*+json: schema: type: array items: $ref: '#/components/schemas/NotePriority' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-references: post: tags: - Note References summary: Create NoteReference description: Creates a new NoteReference operationId: CreateNoteReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteReference' text/json: schema: $ref: '#/components/schemas/NoteReference' application/*+json: schema: $ref: '#/components/schemas/NoteReference' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteReferenceVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteReferenceVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteReferenceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-data/{noteKey}/note-references': get: tags: - Note References summary: List NoteReference description: Lists all NoteReference for the given noteKey operationId: ListNoteReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteKey in: path description: Note Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteReferenceListVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteReferenceListVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteReferenceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-references/{referenceKey}': get: tags: - Note References summary: Get NoteReference description: Gets NoteReference operationId: GetNoteReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: referenceKey in: path description: Reference Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteReferenceVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteReferenceVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteReferenceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Note References summary: Update NoteReference description: Updates a specific NoteReference. operationId: UpdateNoteReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: referenceKey in: path description: Reference Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteReference' text/json: schema: $ref: '#/components/schemas/NoteReference' application/*+json: schema: $ref: '#/components/schemas/NoteReference' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteReferenceVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteReferenceVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteReferenceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Note References summary: Delete NoteReference description: Deletes an NoteReference operationId: DeleteNoteReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: referenceKey in: path description: Reference Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-references-batch: put: tags: - Note References summary: Create or Update Batch NoteReference description: 'Create or Update multiple NoteReference at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNoteReference parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NoteReference' text/json: schema: type: array items: $ref: '#/components/schemas/NoteReference' application/*+json: schema: type: array items: $ref: '#/components/schemas/NoteReference' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-sources: post: tags: - Note Sources summary: Create NoteSource description: Creates a new NoteSource operationId: CreateNoteSource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteSource' text/json: schema: $ref: '#/components/schemas/NoteSource' application/*+json: schema: $ref: '#/components/schemas/NoteSource' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteSourceVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteSourceVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteSourceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-data/{noteKey}/note-sources': get: tags: - Note Sources summary: List NoteSource description: Lists all NoteSource for the given noteKey operationId: ListNoteSource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteKey in: path description: Note Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteSourceListVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteSourceListVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteSourceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-sources/{sourceKey}': get: tags: - Note Sources summary: Get NoteSource description: Gets NoteSource operationId: GetNoteSource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sourceKey in: path description: Source Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteSourceVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteSourceVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteSourceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Note Sources summary: Update NoteSource description: Updates a specific NoteSource. operationId: UpdateNoteSource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sourceKey in: path description: Source Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteSource' text/json: schema: $ref: '#/components/schemas/NoteSource' application/*+json: schema: $ref: '#/components/schemas/NoteSource' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteSourceVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteSourceVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteSourceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Note Sources summary: Delete NoteSource description: Deletes an NoteSource operationId: DeleteNoteSource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sourceKey in: path description: Source Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-sources-batch: put: tags: - Note Sources summary: Create or Update Batch NoteSource description: 'Create or Update multiple NoteSource at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNoteSource parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NoteSource' text/json: schema: type: array items: $ref: '#/components/schemas/NoteSource' application/*+json: schema: type: array items: $ref: '#/components/schemas/NoteSource' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-types: post: tags: - Note Types summary: Create NoteType description: Creates a new NoteType operationId: CreateNoteType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteType' text/json: schema: $ref: '#/components/schemas/NoteType' application/*+json: schema: $ref: '#/components/schemas/NoteType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Note Types summary: List NoteType description: 'Lists all NoteType ' operationId: ListNoteType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/note-types/{noteType}': get: tags: - Note Types summary: Get NoteType description: Gets NoteType operationId: GetNoteType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteType in: path description: Note Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Note Types summary: Update NoteType description: Updates a specific NoteType. operationId: UpdateNoteType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteType in: path description: Note Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteType' text/json: schema: $ref: '#/components/schemas/NoteType' application/*+json: schema: $ref: '#/components/schemas/NoteType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/NoteTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/NoteTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/NoteTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Note Types summary: Delete NoteType description: Deletes an NoteType operationId: DeleteNoteType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: noteType in: path description: Note Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /note-types-batch: put: tags: - Note Types summary: Create or Update Batch NoteType description: 'Create or Update multiple NoteType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchNoteType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/NoteType' text/json: schema: type: array items: $ref: '#/components/schemas/NoteType' application/*+json: schema: type: array items: $ref: '#/components/schemas/NoteType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /objects: get: tags: - Objects summary: List Objects description: Gets a list of Objects with optional Functional Area and Purpose filters. operationId: ListObjects parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: functionalArea in: query description: Functional Area filter schema: type: string - name: purpose in: query description: PurposeArea filter schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ObjectListListVBAResponse' application/json: schema: $ref: '#/components/schemas/ObjectListListVBAResponse' text/json: schema: $ref: '#/components/schemas/ObjectListListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /occupations: post: tags: - Occupations summary: Create Occupation description: Creates a new Occupation operationId: CreateOccupation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Occupation' text/json: schema: $ref: '#/components/schemas/Occupation' application/*+json: schema: $ref: '#/components/schemas/Occupation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/OccupationVBAResponse' application/json: schema: $ref: '#/components/schemas/OccupationVBAResponse' text/json: schema: $ref: '#/components/schemas/OccupationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Occupations summary: List Occupation description: Lists all Occupation operationId: ListOccupation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/OccupationListVBAResponse' application/json: schema: $ref: '#/components/schemas/OccupationListVBAResponse' text/json: schema: $ref: '#/components/schemas/OccupationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/occupations/{occupationID}': get: tags: - Occupations summary: Get Occupation description: Gets Occupation operationId: GetOccupation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: occupationID in: path description: Occupation ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/OccupationVBAResponse' application/json: schema: $ref: '#/components/schemas/OccupationVBAResponse' text/json: schema: $ref: '#/components/schemas/OccupationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Occupations summary: Update Occupation description: Updates a specific Occupation. operationId: UpdateOccupation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: occupationID in: path description: Occupation ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Occupation' text/json: schema: $ref: '#/components/schemas/Occupation' application/*+json: schema: $ref: '#/components/schemas/Occupation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/OccupationVBAResponse' application/json: schema: $ref: '#/components/schemas/OccupationVBAResponse' text/json: schema: $ref: '#/components/schemas/OccupationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Occupations summary: Delete Occupation description: Deletes an Occupation operationId: DeleteOccupation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: occupationID in: path description: Occupation ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /occupations-batch: put: tags: - Occupations summary: Create or Update Batch Occupation description: 'Create or Update multiple Occupation at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchOccupation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Occupation' text/json: schema: type: array items: $ref: '#/components/schemas/Occupation' application/*+json: schema: type: array items: $ref: '#/components/schemas/Occupation' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payees: post: tags: - Payees summary: Create Payee description: Creates a new Payee operationId: CreatePayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Payee' text/json: schema: $ref: '#/components/schemas/Payee' application/*+json: schema: $ref: '#/components/schemas/Payee' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayeeVBAResponse' application/json: schema: $ref: '#/components/schemas/PayeeVBAResponse' text/json: schema: $ref: '#/components/schemas/PayeeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Payees summary: List Payee description: Lists all Payee operationId: ListPayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayeeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PayeeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PayeeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payees/{payeeID}': get: tags: - Payees summary: Get Payee description: Gets Payee operationId: GetPayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payeeID in: path description: Payee ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayeeVBAResponse' application/json: schema: $ref: '#/components/schemas/PayeeVBAResponse' text/json: schema: $ref: '#/components/schemas/PayeeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Payees summary: Update Payee description: Updates a specific Payee. operationId: UpdatePayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payeeID in: path description: Payee ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Payee' text/json: schema: $ref: '#/components/schemas/Payee' application/*+json: schema: $ref: '#/components/schemas/Payee' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayeeVBAResponse' application/json: schema: $ref: '#/components/schemas/PayeeVBAResponse' text/json: schema: $ref: '#/components/schemas/PayeeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Payees summary: Delete Payee description: Deletes an Payee operationId: DeletePayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payeeID in: path description: Payee ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payees-batch: put: tags: - Payees summary: Create or Update Batch Payee description: 'Create or Update multiple Payee at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Payee' text/json: schema: type: array items: $ref: '#/components/schemas/Payee' application/*+json: schema: type: array items: $ref: '#/components/schemas/Payee' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payees/{payeeID}/accounts': post: tags: - Payee Accounts summary: Create PayeeAccount description: Creates a new PayeeAccount operationId: CreatePayeeAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payeeID in: path description: Payee ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PayeeAccount' text/json: schema: $ref: '#/components/schemas/PayeeAccount' application/*+json: schema: $ref: '#/components/schemas/PayeeAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayeeAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/PayeeAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/PayeeAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Payee Accounts summary: List PayeeAccount description: Lists all PayeeAccount for the given payeeID operationId: ListPayeeAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payeeID in: path description: Payee ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayeeAccountListVBAResponse' application/json: schema: $ref: '#/components/schemas/PayeeAccountListVBAResponse' text/json: schema: $ref: '#/components/schemas/PayeeAccountListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payees/{payeeID}/accounts/{payeeAccountKey}': get: tags: - Payee Accounts summary: Get PayeeAccount description: Gets PayeeAccount operationId: GetPayeeAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payeeID in: path description: Payee ID required: true schema: type: string - name: payeeAccountKey in: path description: PayeeAccount Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayeeAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/PayeeAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/PayeeAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Payee Accounts summary: Update PayeeAccount description: Updates a specific PayeeAccount. operationId: UpdatePayeeAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payeeID in: path description: Payee ID required: true schema: type: string - name: payeeAccountKey in: path description: PayeeAccount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PayeeAccount' text/json: schema: $ref: '#/components/schemas/PayeeAccount' application/*+json: schema: $ref: '#/components/schemas/PayeeAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayeeAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/PayeeAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/PayeeAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Payee Accounts summary: Delete PayeeAccount description: Deletes an PayeeAccount operationId: DeletePayeeAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payeeID in: path description: Payee ID required: true schema: type: string - name: payeeAccountKey in: path description: PayeeAccount Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payees/{payeeID}/accounts-batch': put: tags: - Payee Accounts summary: Create or Update Batch PayeeAccount description: 'Create or Update multiple PayeeAccount at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPayeeAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payeeID in: path description: Payee ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PayeeAccount' text/json: schema: type: array items: $ref: '#/components/schemas/PayeeAccount' application/*+json: schema: type: array items: $ref: '#/components/schemas/PayeeAccount' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payment-methods: post: tags: - Payment Methods summary: Create PaymentMethod description: Creates a new PaymentMethod operationId: CreatePaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' text/json: schema: $ref: '#/components/schemas/PaymentMethod' application/*+json: schema: $ref: '#/components/schemas/PaymentMethod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PaymentMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/PaymentMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/PaymentMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Payment Methods summary: List PaymentMethod description: Lists all PaymentMethod operationId: ListPaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PaymentMethodListVBAResponse' application/json: schema: $ref: '#/components/schemas/PaymentMethodListVBAResponse' text/json: schema: $ref: '#/components/schemas/PaymentMethodListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payment-methods/{Payment_Method}': get: tags: - Payment Methods summary: Get PaymentMethod description: Gets PaymentMethod operationId: GetPaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Payment_Method in: path description: Payment Method required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PaymentMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/PaymentMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/PaymentMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Payment Methods summary: Update PaymentMethod description: Updates a specific PaymentMethod. operationId: UpdatePaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Payment_Method in: path description: Payment Method required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' text/json: schema: $ref: '#/components/schemas/PaymentMethod' application/*+json: schema: $ref: '#/components/schemas/PaymentMethod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PaymentMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/PaymentMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/PaymentMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Payment Methods summary: Delete PaymentMethod description: Deletes an PaymentMethod operationId: DeletePaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Payment_Method in: path description: Payment Method required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payment-methods-batch: put: tags: - Payment Methods summary: Create or Update Batch PaymentMethod description: 'Create or Update multiple PaymentMethod at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PaymentMethod' text/json: schema: type: array items: $ref: '#/components/schemas/PaymentMethod' application/*+json: schema: type: array items: $ref: '#/components/schemas/PaymentMethod' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payment-methods-by-subscriber/{subscriberId}': get: tags: - Payment Methods summary: List Payment Methods by Subscriber description: 'Based on the submitted Subscriber ID, list Payment Methods for that Subscribers latest enrollment and Billing Cycle.' operationId: ListPaymentMethodBySubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberId in: path description: Subscriber ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PaymentMethodListVBAResponse' application/json: schema: $ref: '#/components/schemas/PaymentMethodListVBAResponse' text/json: schema: $ref: '#/components/schemas/PaymentMethodListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payment-schedules: post: tags: - Payment Schedules summary: Create PaymentSchedule description: Creates a new PaymentSchedule operationId: CreatePaymentSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentSchedule' text/json: schema: $ref: '#/components/schemas/PaymentSchedule' application/*+json: schema: $ref: '#/components/schemas/PaymentSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PaymentScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/PaymentScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/PaymentScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Payment Schedules summary: List PaymentSchedule description: Lists all PaymentSchedule operationId: ListPaymentSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PaymentScheduleListVBAResponse' application/json: schema: $ref: '#/components/schemas/PaymentScheduleListVBAResponse' text/json: schema: $ref: '#/components/schemas/PaymentScheduleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payment-schedules/{paymentSchedule}': get: tags: - Payment Schedules summary: Get PaymentSchedule description: Gets PaymentSchedule operationId: GetPaymentSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: paymentSchedule in: path description: Payment Schedule required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PaymentScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/PaymentScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/PaymentScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Payment Schedules summary: Update PaymentSchedule description: Updates a specific PaymentSchedule. operationId: UpdatePaymentSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: paymentSchedule in: path description: Payment Schedule required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentSchedule' text/json: schema: $ref: '#/components/schemas/PaymentSchedule' application/*+json: schema: $ref: '#/components/schemas/PaymentSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PaymentScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/PaymentScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/PaymentScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Payment Schedules summary: Delete PaymentSchedule description: Deletes an PaymentSchedule operationId: DeletePaymentSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: paymentSchedule in: path description: Payment Schedule required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payment-schedules-batch: put: tags: - Payment Schedules summary: Create or Update Batch PaymentSchedule description: 'Create or Update multiple PaymentSchedule at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPaymentSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PaymentSchedule' text/json: schema: type: array items: $ref: '#/components/schemas/PaymentSchedule' application/*+json: schema: type: array items: $ref: '#/components/schemas/PaymentSchedule' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payors: post: tags: - Payor summary: Create Payor description: Creates a new Payor operationId: CreatePayor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Payor' text/json: schema: $ref: '#/components/schemas/Payor' application/*+json: schema: $ref: '#/components/schemas/Payor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Payor summary: List Payor description: Lists all Payor operationId: ListPayor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorListVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorListVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payors/{payorId}': get: tags: - Payor summary: Get Payor description: Gets Payor operationId: GetPayor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorId in: path description: Payor ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Payor summary: Update Payor description: Updates a specific Payor. operationId: UpdatePayor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorId in: path description: Payor ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Payor' text/json: schema: $ref: '#/components/schemas/Payor' application/*+json: schema: $ref: '#/components/schemas/Payor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Payor summary: Delete Payor description: Deletes an Payor operationId: DeletePayor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorId in: path description: Payor ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payors-batch: put: tags: - Payor summary: Create or Update Batch Payor description: 'Create or Update multiple Payor at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPayor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Payor' text/json: schema: type: array items: $ref: '#/components/schemas/Payor' application/*+json: schema: type: array items: $ref: '#/components/schemas/Payor' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payor-accounts: post: tags: - Payor Accounts summary: Create PayorAccount description: Creates a new PayorAccount operationId: CreatePayorAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PayorAccount' text/json: schema: $ref: '#/components/schemas/PayorAccount' application/*+json: schema: $ref: '#/components/schemas/PayorAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Payor Accounts summary: List PayorAccount description: Lists PayorAccounts with optional Payor_ID filter. operationId: ListPayorAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorID in: query description: Payor ID schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorAccountListVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorAccountListVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorAccountListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payor-accounts/{payorAccountKey}': get: tags: - Payor Accounts summary: Get PayorAccount description: Gets PayorAccount operationId: GetPayorAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorAccountKey in: path description: Payor Account Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Payor Accounts summary: Update PayorAccount description: Updates a specific PayorAccount. operationId: UpdatePayorAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorAccountKey in: path description: Payor Account Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PayorAccount' text/json: schema: $ref: '#/components/schemas/PayorAccount' application/*+json: schema: $ref: '#/components/schemas/PayorAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Payor Accounts summary: Delete PayorAccount description: Deletes an PayorAccount operationId: DeletePayorAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorAccountKey in: path description: Payor Account Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payor-accounts/{payorAccountKey}/account-balance': get: tags: - Payor Accounts - Adv. Accounting summary: Get PayorAccount Balance description: Gets PayorAccount Balance details operationId: GetPayorAccountBalance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorAccountKey in: path description: Payor Account Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FundingAccountBalanceVBAResponse' application/json: schema: $ref: '#/components/schemas/FundingAccountBalanceVBAResponse' text/json: schema: $ref: '#/components/schemas/FundingAccountBalanceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /payor-accounts-batch: put: tags: - Payor Accounts summary: Create or Update Batch PayorAccount description: 'Create or Update multiple PayorAccount at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPayorAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PayorAccount' text/json: schema: type: array items: $ref: '#/components/schemas/PayorAccount' application/*+json: schema: type: array items: $ref: '#/components/schemas/PayorAccount' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payor/{payorId}/funding-accounts/{accountKey}/claims-info': get: tags: - Payor Accounts summary: List Claims Information from a Payor's Funding Account description: List Claims Information from a Payor's Funding Account operationId: ListPayorFundingAccountClaimsInformation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorId in: path description: Payor ID required: true schema: type: string - name: accountKey in: path description: Payor's Funding Account Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_FundingAccountClaimInfoListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_FundingAccountClaimInfoListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_FundingAccountClaimInfoListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payor-account-notifications: post: tags: - Payor Account Notifications summary: Create PayorAccountNotify description: Creates a new PayorAccountNotify operationId: CreatePayorAccountNotify parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PayorAccountNotify' text/json: schema: $ref: '#/components/schemas/PayorAccountNotify' application/*+json: schema: $ref: '#/components/schemas/PayorAccountNotify' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorAccountNotifyVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorAccountNotifyVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorAccountNotifyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Payor Account Notifications summary: List PayorAccountNotify description: Lists all PayorAccountNotify operationId: ListPayorAccountNotify parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorAccountNotifyListVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorAccountNotifyListVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorAccountNotifyListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payor-account-notifications/{payorAccountKey}/{userID}': get: tags: - Payor Account Notifications summary: Get PayorAccountNotify description: Gets PayorAccountNotify operationId: GetPayorAccountNotify parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorAccountKey in: path description: Payor Account Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorAccountNotifyVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorAccountNotifyVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorAccountNotifyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Payor Account Notifications summary: Delete PayorAccountNotify description: Deletes an PayorAccountNotify operationId: DeletePayorAccountNotify parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorAccountKey in: path description: Payor Account Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payor-account-notifications-batch: put: tags: - Payor Account Notifications summary: Create Batch PayorAccountNotify description: 'Create or Update multiple PayorAccountNotify at once. If the entity does not exist, it will be created. Updates are not allowed. If the entity does exist, an error message will be returned with the resultset.' operationId: UpdateBatchPayorAccountNotify parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PayorAccountNotify' text/json: schema: type: array items: $ref: '#/components/schemas/PayorAccountNotify' application/*+json: schema: type: array items: $ref: '#/components/schemas/PayorAccountNotify' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payor-account-signatures: post: tags: - Payor Account Signatures summary: Create PayorAccountSignature description: Creates a new PayorAccountSignature operationId: CreatePayorAccountSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PayorAccountSignature' text/json: schema: $ref: '#/components/schemas/PayorAccountSignature' application/*+json: schema: $ref: '#/components/schemas/PayorAccountSignature' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorAccountSignatureVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorAccountSignatureVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorAccountSignatureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Payor Account Signatures summary: List PayorAccountSignature description: Lists all PayorAccountSignature operationId: ListPayorAccountSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorAccountSignatureListVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorAccountSignatureListVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorAccountSignatureListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payor-account-signatures/{payorAccountSignatureKey}': get: tags: - Payor Account Signatures summary: Get PayorAccountSignature description: Gets PayorAccountSignature operationId: GetPayorAccountSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorAccountSignatureKey in: path description: PayorAccountSignature Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorAccountSignatureVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorAccountSignatureVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorAccountSignatureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Payor Account Signatures summary: Update PayorAccountSignature description: Updates a specific PayorAccountSignature. operationId: UpdatePayorAccountSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorAccountSignatureKey in: path description: PayorAccountSignature Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PayorAccountSignature' text/json: schema: $ref: '#/components/schemas/PayorAccountSignature' application/*+json: schema: $ref: '#/components/schemas/PayorAccountSignature' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorAccountSignatureVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorAccountSignatureVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorAccountSignatureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Payor Account Signatures summary: Delete PayorAccountSignature description: Deletes an PayorAccountSignature operationId: DeletePayorAccountSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorAccountSignatureKey in: path description: PayorAccountSignature Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payor-account-signatures-batch: put: tags: - Payor Account Signatures summary: Create or Update Batch PayorAccountSignature description: 'Create or Update multiple PayorAccountSignature at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPayorAccountSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PayorAccountSignature' text/json: schema: type: array items: $ref: '#/components/schemas/PayorAccountSignature' application/*+json: schema: type: array items: $ref: '#/components/schemas/PayorAccountSignature' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payors/{payorID}/filters': post: tags: - Payor Filters summary: Create PayorFilter description: Creates a new PayorFilter operationId: CreatePayorFilter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorID in: path description: Payor ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PayorFilter' text/json: schema: $ref: '#/components/schemas/PayorFilter' application/*+json: schema: $ref: '#/components/schemas/PayorFilter' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorFilterVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorFilterVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorFilterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Payor Filters summary: List PayorFilter description: Lists all PayorFilter for the given payorID operationId: ListPayorFilter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorID in: path description: Payor ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorFilterListVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorFilterListVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorFilterListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payors/{payorID}/filters/{payorFilterKey}': get: tags: - Payor Filters summary: Get PayorFilter description: Gets PayorFilter operationId: GetPayorFilter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorID in: path description: Payor ID required: true schema: type: string - name: payorFilterKey in: path description: PayorFilter Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorFilterVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorFilterVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorFilterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Payor Filters summary: Update PayorFilter description: Updates a specific PayorFilter. operationId: UpdatePayorFilter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorID in: path description: Payor ID required: true schema: type: string - name: payorFilterKey in: path description: PayorFilter Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PayorFilter' text/json: schema: $ref: '#/components/schemas/PayorFilter' application/*+json: schema: $ref: '#/components/schemas/PayorFilter' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorFilterVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorFilterVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorFilterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Payor Filters summary: Delete PayorFilter description: Deletes an PayorFilter operationId: DeletePayorFilter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorID in: path description: Payor ID required: true schema: type: string - name: payorFilterKey in: path description: PayorFilter Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payors/{payorID}/filters-batch': put: tags: - Payor Filters summary: Create or Update Batch PayorFilter description: 'Create or Update multiple PayorFilter at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPayorFilter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorID in: path description: Payor ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PayorFilter' text/json: schema: type: array items: $ref: '#/components/schemas/PayorFilter' application/*+json: schema: type: array items: $ref: '#/components/schemas/PayorFilter' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payors/{payorID}/reports': post: tags: - Payor Reports summary: Create PayorReport description: Creates a new PayorReport operationId: CreatePayorReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorID in: path description: Payor ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PayorReport' text/json: schema: $ref: '#/components/schemas/PayorReport' application/*+json: schema: $ref: '#/components/schemas/PayorReport' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorReportVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorReportVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorReportVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Payor Reports summary: List PayorReport description: Lists all PayorReport for the given payorID operationId: ListPayorReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorID in: path description: Payor ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorReportListVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorReportListVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorReportListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payors/{payorID}/reports/{reportDefinitionKey}': get: tags: - Payor Reports summary: Get PayorReport description: Gets PayorReport operationId: GetPayorReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorID in: path description: Payor ID required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PayorReportVBAResponse' application/json: schema: $ref: '#/components/schemas/PayorReportVBAResponse' text/json: schema: $ref: '#/components/schemas/PayorReportVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Payor Reports summary: Delete PayorReport description: Deletes an PayorReport operationId: DeletePayorReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorID in: path description: Payor ID required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/payors/{payorID}/reports-batch': put: tags: - Payor Reports summary: Create or Update Batch PayorReport description: 'Create or Update multiple PayorReport at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPayorReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payorID in: path description: Payor ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PayorReport' text/json: schema: type: array items: $ref: '#/components/schemas/PayorReport' application/*+json: schema: type: array items: $ref: '#/components/schemas/PayorReport' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /pbm-types: post: tags: - PBM Types summary: Create PBMType description: Creates a new PBMType operationId: CreatePBMType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PBMType' text/json: schema: $ref: '#/components/schemas/PBMType' application/*+json: schema: $ref: '#/components/schemas/PBMType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PBMTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PBMTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PBMTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - PBM Types summary: List PBMType description: 'Lists all PBMType ' operationId: ListPBMType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PBMTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PBMTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PBMTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/pbm-types/{pBMType}': get: tags: - PBM Types summary: Get PBMType description: Gets PBMType operationId: GetPBMType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: pBMType in: path description: PBM Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PBMTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PBMTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PBMTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - PBM Types summary: Update PBMType description: Updates a specific PBMType. operationId: UpdatePBMType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: pBMType in: path description: PBM Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PBMType' text/json: schema: $ref: '#/components/schemas/PBMType' application/*+json: schema: $ref: '#/components/schemas/PBMType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PBMTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PBMTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PBMTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - PBM Types summary: Delete PBMType description: Deletes an PBMType operationId: DeletePBMType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: pBMType in: path description: PBM Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /pbm-types-batch: put: tags: - PBM Types summary: Create or Update Batch PBMType description: 'Create or Update multiple PBMType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPBMType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PBMType' text/json: schema: type: array items: $ref: '#/components/schemas/PBMType' application/*+json: schema: type: array items: $ref: '#/components/schemas/PBMType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /place-codes: post: tags: - Places of Service summary: Create PlaceCodes description: Creates a new PlaceCodes operationId: CreatePlaceCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlaceCodes' text/json: schema: $ref: '#/components/schemas/PlaceCodes' application/*+json: schema: $ref: '#/components/schemas/PlaceCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlaceCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/PlaceCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/PlaceCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Places of Service summary: List PlaceCodes description: 'Lists all PlaceCodes ' operationId: ListPlaceCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlaceCodesListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlaceCodesListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlaceCodesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/place-codes/{placeCode}': get: tags: - Places of Service summary: Get PlaceCodes description: Gets PlaceCodes operationId: GetPlaceCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlaceCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/PlaceCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/PlaceCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Places of Service summary: Update PlaceCodes description: Updates a specific PlaceCodes. operationId: UpdatePlaceCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlaceCodes' text/json: schema: $ref: '#/components/schemas/PlaceCodes' application/*+json: schema: $ref: '#/components/schemas/PlaceCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlaceCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/PlaceCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/PlaceCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Places of Service summary: Delete PlaceCodes description: Deletes an PlaceCodes operationId: DeletePlaceCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /place-codes-batch: put: tags: - Places of Service summary: Create or Update Batch PlaceCodes description: 'Create or Update multiple PlaceCodes at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlaceCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlaceCodes' text/json: schema: type: array items: $ref: '#/components/schemas/PlaceCodes' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlaceCodes' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/accumulators': post: tags: - Plan Accumulators summary: Create Plan Accumulator description: Creates a new Plan Accumulator operationId: CreatePlanAddedAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanAddedAccum' text/json: schema: $ref: '#/components/schemas/PlanAddedAccum' application/*+json: schema: $ref: '#/components/schemas/PlanAddedAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAddedAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAddedAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAddedAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Accumulators summary: List Plan Accumulator description: Lists all Plan Accumulator given a specific Plan ID operationId: ListPlanAddedAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAddedAccumListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAddedAccumListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAddedAccumListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/accumulators/{accumName}': get: tags: - Plan Accumulators summary: Get Plan Accumulator description: Gets Plan Accumulator operationId: GetPlanAddedAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: accumName in: path description: Accum Name required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAddedAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAddedAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAddedAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Accumulators summary: Update Plan Accumulator description: Updates a specific Plan Accumulator. operationId: UpdatePlanAddedAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: accumName in: path description: Accum Name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanAddedAccum' text/json: schema: $ref: '#/components/schemas/PlanAddedAccum' application/*+json: schema: $ref: '#/components/schemas/PlanAddedAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAddedAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAddedAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAddedAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Accumulators summary: Delete Plan Accumulator description: Deletes an Plan Accumulator operationId: DeletePlanAddedAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: accumName in: path description: Accum Name required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/accumulators-batch': put: tags: - Plan Accumulators summary: Create or Update Batch Plan Accumulator description: 'Create or Update multiple Plan Accumulator at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanAddedAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanAddedAccum' text/json: schema: type: array items: $ref: '#/components/schemas/PlanAddedAccum' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanAddedAccum' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/accumulators/{accumName}/benefits/{benefitCode}': post: tags: - Plan Accumulator Benefits summary: Create PlanAddedAccumBenefits description: Creates a new PlanAddedAccumBenefits operationId: CreatePlanAddedAccumBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: accumName in: path description: Accum Name required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanAddedAccumBenefits' text/json: schema: $ref: '#/components/schemas/PlanAddedAccumBenefits' application/*+json: schema: $ref: '#/components/schemas/PlanAddedAccumBenefits' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAddedAccumBenefitsVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAddedAccumBenefitsVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAddedAccumBenefitsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Accumulator Benefits summary: Get PlanAddedAccumBenefits description: Gets PlanAddedAccumBenefits operationId: GetPlanAddedAccumBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: accumName in: path description: Accum Name required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAddedAccumBenefitsVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAddedAccumBenefitsVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAddedAccumBenefitsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Accumulator Benefits summary: Delete PlanAddedAccumBenefits description: Deletes an PlanAddedAccumBenefits operationId: DeletePlanAddedAccumBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: accumName in: path description: Accum Name required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/accumulators/{accumName}/benefits': get: tags: - Plan Accumulator Benefits summary: List PlanAddedAccumBenefits description: 'Lists all PlanAddedAccumBenefits planID,accumName' operationId: ListPlanAddedAccumBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: accumName in: path description: Accum Name required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAddedAccumBenefitsListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAddedAccumBenefitsListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAddedAccumBenefitsListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/accumulators/{accumName}/benefits-batch': put: tags: - Plan Accumulator Benefits summary: Create Batch PlanAddedAccumBenefits description: 'Create multiple PlanAddedAccumBenefits at once. If the entity exists, an error message will be added to the response. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanAddedAccumBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: accumName in: path description: Accum Name required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanAddedAccumBenefits' text/json: schema: type: array items: $ref: '#/components/schemas/PlanAddedAccumBenefits' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanAddedAccumBenefits' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/auth-penalties': post: tags: - Plan Auth Penalties summary: Create PlanAuthPenalty description: Creates a new PlanAuthPenalty operationId: CreatePlanAuthPenalty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanAuthPenalty' text/json: schema: $ref: '#/components/schemas/PlanAuthPenalty' application/*+json: schema: $ref: '#/components/schemas/PlanAuthPenalty' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAuthPenaltyVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Auth Penalties summary: List PlanAuthPenalty description: Lists all PlanAuthPenalty planID operationId: ListPlanAuthPenalty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAuthPenaltyListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/auth-penalties/{planAuthPenaltyKey}': get: tags: - Plan Auth Penalties summary: Get PlanAuthPenalty description: Gets PlanAuthPenalty operationId: GetPlanAuthPenalty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planAuthPenaltyKey in: path description: PlanAuthPenalty Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAuthPenaltyVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Auth Penalties summary: Update PlanAuthPenalty description: Updates a specific PlanAuthPenalty. operationId: UpdatePlanAuthPenalty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planAuthPenaltyKey in: path description: PlanAuthPenalty Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanAuthPenalty' text/json: schema: $ref: '#/components/schemas/PlanAuthPenalty' application/*+json: schema: $ref: '#/components/schemas/PlanAuthPenalty' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAuthPenaltyVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Auth Penalties summary: Delete PlanAuthPenalty description: Deletes an PlanAuthPenalty operationId: DeletePlanAuthPenalty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planAuthPenaltyKey in: path description: PlanAuthPenalty Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/auth-penalties-batch': put: tags: - Plan Auth Penalties summary: Create or Update Batch PlanAuthPenalty description: 'Create or Update multiple PlanAuthPenalty at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanAuthPenalty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanAuthPenalty' text/json: schema: type: array items: $ref: '#/components/schemas/PlanAuthPenalty' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanAuthPenalty' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/auth-penalties/{planAuthPenaltyKey}/benefits': post: tags: - Plan Auth Penalty Benefits summary: Create PlanAuthPenaltyBenefit description: Creates a new PlanAuthPenaltyBenefit operationId: CreatePlanAuthPenaltyBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planAuthPenaltyKey in: path description: PlanAuthPenalty Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefit' text/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefit' application/*+json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Auth Penalty Benefits summary: List PlanAuthPenaltyBenefit description: Lists all PlanAuthPenaltyBenefit for the given planAuthPenaltyKey operationId: ListPlanAuthPenaltyBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planAuthPenaltyKey in: path description: PlanAuthPenalty Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefitListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefitListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefitListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/auth-penalties/{planAuthPenaltyKey}/benefits/{benefitCode}': get: tags: - Plan Auth Penalty Benefits summary: Get PlanAuthPenaltyBenefit description: Gets PlanAuthPenaltyBenefit operationId: GetPlanAuthPenaltyBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planAuthPenaltyKey in: path description: PlanAuthPenalty Key required: true schema: type: integer format: int32 - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Auth Penalty Benefits summary: Update PlanAuthPenaltyBenefit description: Updates a specific PlanAuthPenaltyBenefit. operationId: UpdatePlanAuthPenaltyBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planAuthPenaltyKey in: path description: PlanAuthPenalty Key required: true schema: type: integer format: int32 - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefit' text/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefit' application/*+json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanAuthPenaltyBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Auth Penalty Benefits summary: Delete PlanAuthPenaltyBenefit description: Deletes an PlanAuthPenaltyBenefit operationId: DeletePlanAuthPenaltyBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planAuthPenaltyKey in: path description: PlanAuthPenalty Key required: true schema: type: integer format: int32 - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/auth-penalties/{planAuthPenaltyKey}/benefits-batch': put: tags: - Plan Auth Penalty Benefits summary: Create or Update Batch PlanAuthPenaltyBenefit description: 'Create or Update multiple PlanAuthPenaltyBenefit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanAuthPenaltyBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planAuthPenaltyKey in: path description: PlanAuthPenalty Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanAuthPenaltyBenefit' text/json: schema: type: array items: $ref: '#/components/schemas/PlanAuthPenaltyBenefit' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanAuthPenaltyBenefit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/diagnoses': post: tags: - Plan Benefit Diagnostic Codes summary: Create PlanBenCodeDiagCode description: Creates a new PlanBenCodeDiagCode operationId: CreatePlanBenCodeDiagCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCode' text/json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCode' application/*+json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeDiagCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Diagnostic Codes summary: List PlanBenCodeDiagCode description: Lists all PlanBenCodeDiagCode for the given planID and benefitCode operationId: ListPlanBenCodeDiagCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeDiagCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/diagnoses/{diagnosticCodeType}/{fromDiagCode}': get: tags: - Plan Benefit Diagnostic Codes summary: Get PlanBenCodeDiagCode description: Gets PlanBenCodeDiagCode operationId: GetPlanBenCodeDiagCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: fromDiagCode in: path description: From Diag Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeDiagCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Diagnostic Codes summary: Update PlanBenCodeDiagCode description: Updates a specific PlanBenCodeDiagCode. operationId: UpdatePlanBenCodeDiagCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: fromDiagCode in: path description: From Diag Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCode' text/json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCode' application/*+json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeDiagCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeDiagCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Diagnostic Codes summary: Delete PlanBenCodeDiagCode description: Deletes an PlanBenCodeDiagCode operationId: DeletePlanBenCodeDiagCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: fromDiagCode in: path description: From Diag Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/diagnoses-batch': put: tags: - Plan Benefit Diagnostic Codes summary: Create or Update Batch PlanBenCodeDiagCode description: 'Create or Update multiple PlanBenCodeDiagCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenCodeDiagCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodeDiagCode' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodeDiagCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodeDiagCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/places': post: tags: - Plan Benefit Places summary: Create PlanBenCodePlace description: Creates a new PlanBenCodePlace operationId: CreatePlanBenCodePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenCodePlace' text/json: schema: $ref: '#/components/schemas/PlanBenCodePlace' application/*+json: schema: $ref: '#/components/schemas/PlanBenCodePlace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodePlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodePlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodePlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Places summary: List PlanBenCodePlace description: Lists all PlanBenCodePlace for the given planID and benefitCode operationId: ListPlanBenCodePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodePlaceListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodePlaceListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodePlaceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/places/{placeCode}': get: tags: - Plan Benefit Places summary: Get PlanBenCodePlace description: Gets PlanBenCodePlace operationId: GetPlanBenCodePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodePlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodePlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodePlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Places summary: Update PlanBenCodePlace description: Updates a specific PlanBenCodePlace. operationId: UpdatePlanBenCodePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenCodePlace' text/json: schema: $ref: '#/components/schemas/PlanBenCodePlace' application/*+json: schema: $ref: '#/components/schemas/PlanBenCodePlace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodePlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodePlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodePlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Places summary: Delete PlanBenCodePlace description: Deletes an PlanBenCodePlace operationId: DeletePlanBenCodePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/places-batch': put: tags: - Plan Benefit Places summary: Create or Update Batch PlanBenCodePlace description: 'Create or Update multiple PlanBenCodePlace at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenCodePlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodePlace' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodePlace' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodePlace' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/procedure-codes': post: tags: - Plan Benefit Procedures summary: Create PlanBenCodeProcCode description: Creates a new PlanBenCodeProcCode operationId: CreatePlanBenCodeProcCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenCodeProcCode' text/json: schema: $ref: '#/components/schemas/PlanBenCodeProcCode' application/*+json: schema: $ref: '#/components/schemas/PlanBenCodeProcCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeProcCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeProcCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeProcCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Procedures summary: List PlanBenCodeProcCode description: Lists all PlanBenCodeProcCode for the given planID and benefitCode operationId: ListPlanBenCodeProcCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeProcCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeProcCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeProcCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/procedure-codes-batch': put: tags: - Plan Benefit Procedures summary: Create or Update Batch PlanBenCodeProcCode description: 'Create or Update multiple PlanBenCodeProcCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenCodeProcCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodeProcCode' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodeProcCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodeProcCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/procedure-codes/{fromProcedure}': get: tags: - Plan Benefit Procedures summary: Get PlanBenCodeProcCode description: Gets PlanBenCodeProcCode operationId: GetPlanBenCodeProcCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: fromProcedure in: path description: From Procedure required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeProcCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeProcCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeProcCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Procedures summary: Update PlanBenCodeProcCode description: Updates a specific PlanBenCodeProcCode. operationId: UpdatePlanBenCodeProcCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: fromProcedure in: path description: From Procedure required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenCodeProcCode' text/json: schema: $ref: '#/components/schemas/PlanBenCodeProcCode' application/*+json: schema: $ref: '#/components/schemas/PlanBenCodeProcCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeProcCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeProcCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeProcCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Procedures summary: Delete PlanBenCodeProcCode description: Deletes an PlanBenCodeProcCode operationId: DeletePlanBenCodeProcCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: fromProcedure in: path description: From Procedure required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/provider-types': post: tags: - Plan Benefit Provider Types summary: Create PlanBenCodeProviderType description: Creates a new PlanBenCodeProviderType operationId: CreatePlanBenCodeProviderType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenCodeProviderType' text/json: schema: $ref: '#/components/schemas/PlanBenCodeProviderType' application/*+json: schema: $ref: '#/components/schemas/PlanBenCodeProviderType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeProviderTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeProviderTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeProviderTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Provider Types summary: List PlanBenCodeProviderType description: Lists all PlanBenCodeProviderType for the given planID and benefitCode operationId: ListPlanBenCodeProviderType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeProviderTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeProviderTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeProviderTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/provider-types/{providerType}': get: tags: - Plan Benefit Provider Types summary: Get PlanBenCodeProviderType description: Gets PlanBenCodeProviderType operationId: GetPlanBenCodeProviderType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: providerType in: path description: Provider Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeProviderTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeProviderTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeProviderTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Provider Types summary: Update PlanBenCodeProviderType description: Updates a specific PlanBenCodeProviderType. operationId: UpdatePlanBenCodeProviderType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: providerType in: path description: Provider Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenCodeProviderType' text/json: schema: $ref: '#/components/schemas/PlanBenCodeProviderType' application/*+json: schema: $ref: '#/components/schemas/PlanBenCodeProviderType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeProviderTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeProviderTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeProviderTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Provider Types summary: Delete PlanBenCodeProviderType description: Deletes an PlanBenCodeProviderType operationId: DeletePlanBenCodeProviderType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: providerType in: path description: Provider Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/provider-types-batch': put: tags: - Plan Benefit Provider Types summary: Create or Update Batch PlanBenCodeProviderType description: 'Create or Update multiple PlanBenCodeProviderType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenCodeProviderType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodeProviderType' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodeProviderType' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodeProviderType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/specialties': post: tags: - Plan Benefit Specialties summary: Create PlanBenCodeSpecialty description: Creates a new PlanBenCodeSpecialty operationId: CreatePlanBenCodeSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialty' text/json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialty' application/*+json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialty' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeSpecialtyVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialtyVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialtyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Specialties summary: List PlanBenCodeSpecialty description: Lists all PlanBenCodeSpecialty for the given planID and benefitCode operationId: ListPlanBenCodeSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeSpecialtyListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialtyListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialtyListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/specialties/{specialtyCode}': get: tags: - Plan Benefit Specialties summary: Get PlanBenCodeSpecialty description: Gets PlanBenCodeSpecialty operationId: GetPlanBenCodeSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: specialtyCode in: path description: Specialty Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeSpecialtyVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialtyVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialtyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Specialties summary: Update PlanBenCodeSpecialty description: Updates a specific PlanBenCodeSpecialty. operationId: UpdatePlanBenCodeSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: specialtyCode in: path description: Specialty Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialty' text/json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialty' application/*+json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialty' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenCodeSpecialtyVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialtyVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenCodeSpecialtyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Specialties summary: Delete PlanBenCodeSpecialty description: Deletes an PlanBenCodeSpecialty operationId: DeletePlanBenCodeSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: specialtyCode in: path description: Specialty Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/specialties-batch': put: tags: - Plan Benefit Specialties summary: Create or Update Batch PlanBenCodeSpecialty description: 'Create or Update multiple PlanBenCodeSpecialty at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenCodeSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodeSpecialty' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodeSpecialty' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenCodeSpecialty' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/parent-benefits/{parentBenefitCode}/cascade-benefits/{cascadeBenefitCode}': post: tags: - Plan Benefit Cascades summary: Create PlanBenefitCascade description: Creates a new PlanBenefitCascade operationId: CreatePlanBenefitCascade parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: parentBenefitCode in: path description: Parent Benefit Code required: true schema: type: string - name: cascadeBenefitCode in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitCascade' text/json: schema: $ref: '#/components/schemas/PlanBenefitCascade' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitCascade' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitCascadeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitCascadeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitCascadeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Cascades summary: Get PlanBenefitCascade description: Gets PlanBenefitCascade operationId: GetPlanBenefitCascade parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: parentBenefitCode in: path description: Parent Benefit Code required: true schema: type: string - name: cascadeBenefitCode in: path description: Cascade Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitCascadeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitCascadeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitCascadeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Cascades summary: Delete PlanBenefitCascade description: Deletes an PlanBenefitCascade operationId: DeletePlanBenefitCascade parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: parentBenefitCode in: path description: Parent Benefit Code required: true schema: type: string - name: cascadeBenefitCode in: path description: Cascade Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/cascade-benefits': get: tags: - Plan Benefit Cascades summary: List PlanBenefitCascade description: Lists all PlanBenefitCascade for the given planID operationId: ListPlanBenefitCascade parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitCascadeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitCascadeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitCascadeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/parent-benefits/{parentBenefitCode}/cascade-benefits': put: tags: - Plan Benefit Cascades summary: Create or Update Batch PlanBenefitCascade description: 'Create or Update multiple PlanBenefitCascade at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenefitCascade parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: parentBenefitCode in: path description: Parent Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitCascade' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitCascade' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitCascade' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /plan-benefit-clusters: post: tags: - Plan Benefit Clusters summary: Create PlanBenefitCluster description: Creates a new PlanBenefitCluster operationId: CreatePlanBenefitCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitCluster' text/json: schema: $ref: '#/components/schemas/PlanBenefitCluster' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitCluster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Clusters summary: List PlanBenefitCluster description: Lists all PlanBenefitCluster operationId: ListPlanBenefitCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planId in: query description: Plan ID schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitClusterListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitClusterListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitClusterListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plan-benefit-clusters/{planBenefitClusterKey}': get: tags: - Plan Benefit Clusters summary: Get PlanBenefitCluster description: Gets PlanBenefitCluster operationId: GetPlanBenefitCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planBenefitClusterKey in: path description: PlanBenefitCluster Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Clusters summary: Update PlanBenefitCluster description: Updates a specific PlanBenefitCluster. operationId: UpdatePlanBenefitCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planBenefitClusterKey in: path description: PlanBenefitCluster Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitCluster' text/json: schema: $ref: '#/components/schemas/PlanBenefitCluster' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitCluster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Clusters summary: Delete PlanBenefitCluster description: Deletes an PlanBenefitCluster operationId: DeletePlanBenefitCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planBenefitClusterKey in: path description: PlanBenefitCluster Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /plan-benefit-clusters-batch: put: tags: - Plan Benefit Clusters summary: Create or Update Batch PlanBenefitCluster description: 'Create or Update multiple PlanBenefitCluster at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenefitCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitCluster' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitCluster' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitCluster' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/levels': post: tags: - Plan Benefit Levels summary: Create PlanBenefitLevel description: Creates a new PlanBenefitLevel operationId: CreatePlanBenefitLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitLevel' text/json: schema: $ref: '#/components/schemas/PlanBenefitLevel' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitLevel' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitLevelVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitLevelVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitLevelVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Levels summary: List PlanBenefitLevel description: Lists all PlanBenefitLevel for the given planID and benefitCode operationId: ListPlanBenefitLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitLevelListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitLevelListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitLevelListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/levels/{planBenefitLevelKey}': get: tags: - Plan Benefit Levels summary: Get PlanBenefitLevel description: Gets PlanBenefitLevel operationId: GetPlanBenefitLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: planBenefitLevelKey in: path description: PlanBenefitLevel Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitLevelVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitLevelVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitLevelVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Levels summary: Update PlanBenefitLevel description: Updates a specific PlanBenefitLevel. operationId: UpdatePlanBenefitLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: planBenefitLevelKey in: path description: PlanBenefitLevel Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitLevel' text/json: schema: $ref: '#/components/schemas/PlanBenefitLevel' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitLevel' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitLevelVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitLevelVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitLevelVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Levels summary: Delete PlanBenefitLevel description: Deletes an PlanBenefitLevel operationId: DeletePlanBenefitLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: planBenefitLevelKey in: path description: PlanBenefitLevel Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/levels-batch': put: tags: - Plan Benefit Levels summary: Create or Update Batch PlanBenefitLevel description: 'Create or Update multiple PlanBenefitLevel at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenefitLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitLevel' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitLevel' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitLevel' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/pbm-co-pays': post: tags: - Plan Benefit PBM Co-Pays summary: Create PlanBenefitPBM description: Creates a new PlanBenefitPBM operationId: CreatePlanBenefitPBM parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitPBM' text/json: schema: $ref: '#/components/schemas/PlanBenefitPBM' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitPBM' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitPBMVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitPBMVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitPBMVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit PBM Co-Pays summary: List PlanBenefitPBM description: Lists all PlanBenefitPBM for the given planID and benefitCode operationId: ListPlanBenefitPBM parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitPBMListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitPBMListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitPBMListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/pbm-co-pays/{pBMType}': get: tags: - Plan Benefit PBM Co-Pays summary: Get PlanBenefitPBM description: Gets PlanBenefitPBM operationId: GetPlanBenefitPBM parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: pBMType in: path description: PBM Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitPBMVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitPBMVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitPBMVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit PBM Co-Pays summary: Update PlanBenefitPBM description: Updates a specific PlanBenefitPBM. operationId: UpdatePlanBenefitPBM parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: pBMType in: path description: PBM Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitPBM' text/json: schema: $ref: '#/components/schemas/PlanBenefitPBM' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitPBM' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitPBMVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitPBMVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitPBMVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit PBM Co-Pays summary: Delete PlanBenefitPBM description: Deletes an PlanBenefitPBM operationId: DeletePlanBenefitPBM parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: pBMType in: path description: PBM Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/pbm-co-pays-batch': put: tags: - Plan Benefit PBM Co-Pays summary: Create or Update Batch PlanBenefitPBM description: 'Create or Update multiple PlanBenefitPBM at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenefitPBM parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitPBM' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitPBM' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitPBM' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/rates': post: tags: - Plan Benefit Rates summary: Create PlanBenefitRate description: Creates a new PlanBenefitRate operationId: CreatePlanBenefitRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitRate' text/json: schema: $ref: '#/components/schemas/PlanBenefitRate' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitRateVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitRateVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Rates summary: List PlanBenefitRate description: Lists all PlanBenefitRate for the given planID and benefitCode operationId: ListPlanBenefitRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitRateListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitRateListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitRateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/rates/{planBenefitRateKey}': get: tags: - Plan Benefit Rates summary: Get PlanBenefitRate description: Gets PlanBenefitRate operationId: GetPlanBenefitRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: planBenefitRateKey in: path description: PlanBenefitRate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitRateVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitRateVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Rates summary: Update PlanBenefitRate description: Updates a specific PlanBenefitRate. operationId: UpdatePlanBenefitRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: planBenefitRateKey in: path description: PlanBenefitRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitRate' text/json: schema: $ref: '#/components/schemas/PlanBenefitRate' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitRateVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitRateVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Rates summary: Delete PlanBenefitRate description: Deletes an PlanBenefitRate operationId: DeletePlanBenefitRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: planBenefitRateKey in: path description: PlanBenefitRate Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/rates-batch': put: tags: - Plan Benefit Rates summary: Create or Update Batch PlanBenefitRate description: 'Create or Update multiple PlanBenefitRate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenefitRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitRate' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitRate' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitRate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits': post: tags: - Plan Benefits summary: Create PlanBenefits description: Creates a new PlanBenefits operationId: CreatePlanBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefits' text/json: schema: $ref: '#/components/schemas/PlanBenefits' application/*+json: schema: $ref: '#/components/schemas/PlanBenefits' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefits summary: List PlanBenefits description: Lists all PlanBenefits planID operationId: ListPlanBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}': get: tags: - Plan Benefits summary: Get PlanBenefits description: Gets PlanBenefits operationId: GetPlanBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefits summary: Update PlanBenefits description: Updates a specific PlanBenefits. operationId: UpdatePlanBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefits' text/json: schema: $ref: '#/components/schemas/PlanBenefits' application/*+json: schema: $ref: '#/components/schemas/PlanBenefits' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefits summary: Delete PlanBenefits description: Deletes an PlanBenefits operationId: DeletePlanBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits-batch': put: tags: - Plan Benefits summary: Create or Update Batch PlanBenefits description: 'Create or Update multiple PlanBenefits at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefits' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefits' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenefits' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/included-benefits/{benefitCode}': get: tags: - Plan Benefits summary: List Included PlanBenefits description: Lists all Included PlanBenefits for a given planID and benefitCode operationId: ListIncludedPlanBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/BenefitCodesListVBAResponse' application/json: schema: $ref: '#/components/schemas/BenefitCodesListVBAResponse' text/json: schema: $ref: '#/components/schemas/BenefitCodesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/diagnosis-ex-codes': post: tags: - Plan Benefit Diagnosis Ex Codes summary: Create PlanBenefitsDiagnosis description: Creates a new PlanBenefitsDiagnosis operationId: CreatePlanBenefitsDiagnosis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosis' text/json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosis' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosis' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosisVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosisVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Diagnosis Ex Codes summary: List PlanBenefitsDiagnosis description: Lists all PlanBenefitsDiagnosis for the given planID and benefitCode operationId: ListPlanBenefitsDiagnosis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosisListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosisListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosisListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/diagnosis-ex-codes/{diagnosticCodeType}/{diagnosticCode}': get: tags: - Plan Benefit Diagnosis Ex Codes summary: Get PlanBenefitsDiagnosis description: Gets PlanBenefitsDiagnosis operationId: GetPlanBenefitsDiagnosis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: diagnosticCode in: path description: Diagnostic Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosisVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosisVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Diagnosis Ex Codes summary: Update PlanBenefitsDiagnosis description: Updates a specific PlanBenefitsDiagnosis. operationId: UpdatePlanBenefitsDiagnosis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: diagnosticCode in: path description: Diagnostic Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosis' text/json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosis' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosis' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosisVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosisVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsDiagnosisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Diagnosis Ex Codes summary: Delete PlanBenefitsDiagnosis description: Deletes an PlanBenefitsDiagnosis operationId: DeletePlanBenefitsDiagnosis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: diagnosticCodeType in: path description: Diagnostic Code Type required: true schema: type: string - name: diagnosticCode in: path description: Diagnostic Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/diagnosis-ex-codes-batch': put: tags: - Plan Benefit Diagnosis Ex Codes summary: Create or Update Batch PlanBenefitsDiagnosis description: 'Create or Update multiple PlanBenefitsDiagnosis at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenefitsDiagnosis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsDiagnosis' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsDiagnosis' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsDiagnosis' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/modifier-ex-codes': post: tags: - Plan Benefit Modifier Ex Codes summary: Create PlanBenefitsModifiers description: Creates a new PlanBenefitsModifiers operationId: CreatePlanBenefitsModifiers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsModifiers' text/json: schema: $ref: '#/components/schemas/PlanBenefitsModifiers' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsModifiers' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsModifiersVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsModifiersVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsModifiersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Modifier Ex Codes summary: List PlanBenefitsModifiers description: Lists all PlanBenefitsModifiers for the given planID and benefitCode operationId: ListPlanBenefitsModifiers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsModifiersListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsModifiersListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsModifiersListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/modifier-ex-codes/{modifier}': get: tags: - Plan Benefit Modifier Ex Codes summary: Get PlanBenefitsModifiers description: Gets PlanBenefitsModifiers operationId: GetPlanBenefitsModifiers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: modifier in: path description: Modifier required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsModifiersVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsModifiersVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsModifiersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Modifier Ex Codes summary: Update PlanBenefitsModifiers description: Updates a specific PlanBenefitsModifiers. operationId: UpdatePlanBenefitsModifiers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: modifier in: path description: Modifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsModifiers' text/json: schema: $ref: '#/components/schemas/PlanBenefitsModifiers' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsModifiers' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsModifiersVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsModifiersVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsModifiersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Modifier Ex Codes summary: Delete PlanBenefitsModifiers description: Deletes an PlanBenefitsModifiers operationId: DeletePlanBenefitsModifiers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: modifier in: path description: Modifier required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/modifier-ex-codes-batch': put: tags: - Plan Benefit Modifier Ex Codes summary: Create or Update Batch PlanBenefitsModifiers description: 'Create or Update multiple PlanBenefitsModifiers at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenefitsModifiers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsModifiers' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsModifiers' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsModifiers' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/place-ex-codes': post: tags: - Plan Benefit Place Ex Codes summary: Create PlanBenefitsPlace description: Creates a new PlanBenefitsPlace operationId: CreatePlanBenefitsPlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlace' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlace' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsPlace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Place Ex Codes summary: List PlanBenefitsPlace description: Lists all PlanBenefitsPlace for the given planID and benefitCode operationId: ListPlanBenefitsPlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/place-ex-codes/{placeCode}': get: tags: - Plan Benefit Place Ex Codes summary: Get PlanBenefitsPlace description: Gets PlanBenefitsPlace operationId: GetPlanBenefitsPlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Place Ex Codes summary: Update PlanBenefitsPlace description: Updates a specific PlanBenefitsPlace. operationId: UpdatePlanBenefitsPlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlace' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlace' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsPlace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Place Ex Codes summary: Delete PlanBenefitsPlace description: Deletes an PlanBenefitsPlace operationId: DeletePlanBenefitsPlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/place-ex-codes-batch': put: tags: - Plan Benefit Place Ex Codes summary: Create or Update Batch PlanBenefitsPlace description: 'Create or Update multiple PlanBenefitsPlace at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenefitsPlace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsPlace' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsPlace' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsPlace' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/place-auths': post: tags: - Plan Benefit Place Authorizations summary: Create PlanBenefitsPlaceAuth description: Creates a new PlanBenefitsPlaceAuth operationId: CreatePlanBenefitsPlaceAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuth' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuth' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuth' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuthVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuthVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuthVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Place Authorizations summary: List PlanBenefitsPlaceAuth description: Lists all PlanBenefitsPlaceAuth for the given planID and benefitCode operationId: ListPlanBenefitsPlaceAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuthListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuthListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuthListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/place-auths/{placeCode}': get: tags: - Plan Benefit Place Authorizations summary: Get PlanBenefitsPlaceAuth description: Gets PlanBenefitsPlaceAuth operationId: GetPlanBenefitsPlaceAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuthVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuthVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuthVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Place Authorizations summary: Update PlanBenefitsPlaceAuth description: Updates a specific PlanBenefitsPlaceAuth. operationId: UpdatePlanBenefitsPlaceAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuth' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuth' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuth' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuthVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuthVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceAuthVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Place Authorizations summary: Delete PlanBenefitsPlaceAuth description: Deletes an PlanBenefitsPlaceAuth operationId: DeletePlanBenefitsPlaceAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/place-auths-batch': put: tags: - Plan Benefit Place Authorizations summary: Create or Update Batch PlanBenefitsPlaceAuth description: 'Create or Update multiple PlanBenefitsPlaceAuth at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenefitsPlaceAuth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsPlaceAuth' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsPlaceAuth' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsPlaceAuth' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/place-co-insurance': post: tags: - Plan Benefit Place Co-Insurance summary: Create PlanBenefitsPlaceCoIns description: Creates a new PlanBenefitsPlaceCoIns operationId: CreatePlanBenefitsPlaceCoIns parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoIns' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoIns' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoIns' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoInsVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoInsVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoInsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Place Co-Insurance summary: List PlanBenefitsPlaceCoIns description: Lists all PlanBenefitsPlaceCoIns for the given planID and benefitCode operationId: ListPlanBenefitsPlaceCoIns parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoInsListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoInsListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoInsListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/place-co-insurance/{placeCode}': get: tags: - Plan Benefit Place Co-Insurance summary: Get PlanBenefitsPlaceCoIns description: Gets PlanBenefitsPlaceCoIns operationId: GetPlanBenefitsPlaceCoIns parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoInsVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoInsVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoInsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Place Co-Insurance summary: Update PlanBenefitsPlaceCoIns description: Updates a specific PlanBenefitsPlaceCoIns. operationId: UpdatePlanBenefitsPlaceCoIns parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoIns' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoIns' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoIns' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoInsVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoInsVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoInsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Place Co-Insurance summary: Delete PlanBenefitsPlaceCoIns description: Deletes an PlanBenefitsPlaceCoIns operationId: DeletePlanBenefitsPlaceCoIns parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/place-co-insurance-batch': put: tags: - Plan Benefit Place Co-Insurance summary: Create or Update Batch PlanBenefitsPlaceCoIns description: 'Create or Update multiple PlanBenefitsPlaceCoIns at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenefitsPlaceCoIns parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsPlaceCoIns' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsPlaceCoIns' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsPlaceCoIns' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/place-co-pays': post: tags: - Plan Benefit Place Co-Pays summary: Create PlanBenefitsPlaceCoPay description: Creates a new PlanBenefitsPlaceCoPay operationId: CreatePlanBenefitsPlaceCoPay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPay' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPay' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPay' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPayVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPayVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPayVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Place Co-Pays summary: List PlanBenefitsPlaceCoPay description: Lists all PlanBenefitsPlaceCoPay for the given planID and benefitCode operationId: ListPlanBenefitsPlaceCoPay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPayListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPayListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPayListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/place-co-pays/{placeCode}': get: tags: - Plan Benefit Place Co-Pays summary: Get PlanBenefitsPlaceCoPay description: Gets PlanBenefitsPlaceCoPay operationId: GetPlanBenefitsPlaceCoPay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPayVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPayVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPayVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Place Co-Pays summary: Update PlanBenefitsPlaceCoPay description: Updates a specific PlanBenefitsPlaceCoPay. operationId: UpdatePlanBenefitsPlaceCoPay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPay' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPay' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPay' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPayVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPayVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsPlaceCoPayVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Place Co-Pays summary: Delete PlanBenefitsPlaceCoPay description: Deletes an PlanBenefitsPlaceCoPay operationId: DeletePlanBenefitsPlaceCoPay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: placeCode in: path description: Place Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/place-co-pays-batch': put: tags: - Plan Benefit Place Co-Pays summary: Create or Update Batch PlanBenefitsPlaceCoPay description: 'Create or Update multiple PlanBenefitsPlaceCoPay at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenefitsPlaceCoPay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsPlaceCoPay' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsPlaceCoPay' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsPlaceCoPay' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/procedure-ex-codes': post: tags: - Plan Benefit Procedure Ex Codes summary: Create PlanBenefitsProcedures description: Creates a new PlanBenefitsProcedures operationId: CreatePlanBenefitsProcedures parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsProcedures' text/json: schema: $ref: '#/components/schemas/PlanBenefitsProcedures' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsProcedures' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsProceduresVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsProceduresVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsProceduresVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Procedure Ex Codes summary: List PlanBenefitsProcedures description: Lists all PlanBenefitsProcedures for the given planID and benefitCode operationId: ListPlanBenefitsProcedures parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsProceduresListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsProceduresListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsProceduresListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/procedure-ex-codes/{procedureCode}': get: tags: - Plan Benefit Procedure Ex Codes summary: Get PlanBenefitsProcedures description: Gets PlanBenefitsProcedures operationId: GetPlanBenefitsProcedures parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsProceduresVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsProceduresVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsProceduresVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Procedure Ex Codes summary: Update PlanBenefitsProcedures description: Updates a specific PlanBenefitsProcedures. operationId: UpdatePlanBenefitsProcedures parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanBenefitsProcedures' text/json: schema: $ref: '#/components/schemas/PlanBenefitsProcedures' application/*+json: schema: $ref: '#/components/schemas/PlanBenefitsProcedures' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanBenefitsProceduresVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanBenefitsProceduresVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanBenefitsProceduresVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Procedure Ex Codes summary: Delete PlanBenefitsProcedures description: Deletes an PlanBenefitsProcedures operationId: DeletePlanBenefitsProcedures parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/procedure-ex-codes-batch': put: tags: - Plan Benefit Procedure Ex Codes summary: Create or Update Batch PlanBenefitsProcedures description: 'Create or Update multiple PlanBenefitsProcedures at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanBenefitsProcedures parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsProcedures' text/json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsProcedures' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanBenefitsProcedures' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/diagnosis-age-restrictions': post: tags: - Plan Diagnosis Age Restrictions summary: Create PlanDiagnosisAge description: Creates a new PlanDiagnosisAge operationId: CreatePlanDiagnosisAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanDiagnosisAge' text/json: schema: $ref: '#/components/schemas/PlanDiagnosisAge' application/*+json: schema: $ref: '#/components/schemas/PlanDiagnosisAge' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanDiagnosisAgeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanDiagnosisAgeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanDiagnosisAgeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Diagnosis Age Restrictions summary: List PlanDiagnosisAge description: Lists all PlanDiagnosisAge for the given planID operationId: ListPlanDiagnosisAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanDiagnosisAgeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanDiagnosisAgeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanDiagnosisAgeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/diagnosis-age-restrictions/{planDiagnosisAgeKey}': get: tags: - Plan Diagnosis Age Restrictions summary: Get PlanDiagnosisAge description: Gets PlanDiagnosisAge operationId: GetPlanDiagnosisAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planDiagnosisAgeKey in: path description: PlanDiagnosisAge Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanDiagnosisAgeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanDiagnosisAgeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanDiagnosisAgeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Diagnosis Age Restrictions summary: Update PlanDiagnosisAge description: Updates a specific PlanDiagnosisAge. operationId: UpdatePlanDiagnosisAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planDiagnosisAgeKey in: path description: PlanDiagnosisAge Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanDiagnosisAge' text/json: schema: $ref: '#/components/schemas/PlanDiagnosisAge' application/*+json: schema: $ref: '#/components/schemas/PlanDiagnosisAge' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanDiagnosisAgeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanDiagnosisAgeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanDiagnosisAgeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Diagnosis Age Restrictions summary: Delete PlanDiagnosisAge description: Deletes an PlanDiagnosisAge operationId: DeletePlanDiagnosisAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planDiagnosisAgeKey in: path description: PlanDiagnosisAge Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/diagnosis-age-restrictions-batch': put: tags: - Plan Diagnosis Age Restrictions summary: Create or Update Batch PlanDiagnosisAge description: 'Create or Update multiple PlanDiagnosisAge at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanDiagnosisAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanDiagnosisAge' text/json: schema: type: array items: $ref: '#/components/schemas/PlanDiagnosisAge' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanDiagnosisAge' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/displays': post: tags: - Plan Displays summary: Create PlanDisplay description: Creates a new PlanDisplay operationId: CreatePlanDisplay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanDisplay' text/json: schema: $ref: '#/components/schemas/PlanDisplay' application/*+json: schema: $ref: '#/components/schemas/PlanDisplay' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanDisplayVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanDisplayVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanDisplayVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Displays summary: List PlanDisplay description: Lists all PlanDisplay operationId: ListPlanDisplay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanDisplayListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanDisplayListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanDisplayListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/displays/{planDisplayKey}': get: tags: - Plan Displays summary: Get PlanDisplay description: Gets PlanDisplay operationId: GetPlanDisplay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planDisplayKey in: path description: PlanDisplay Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanDisplayVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanDisplayVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanDisplayVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Displays summary: Update PlanDisplay description: Updates a specific PlanDisplay. operationId: UpdatePlanDisplay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planDisplayKey in: path description: PlanDisplay Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanDisplay' text/json: schema: $ref: '#/components/schemas/PlanDisplay' application/*+json: schema: $ref: '#/components/schemas/PlanDisplay' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanDisplayVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanDisplayVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanDisplayVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Displays summary: Delete PlanDisplay description: Deletes an PlanDisplay operationId: DeletePlanDisplay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planDisplayKey in: path description: PlanDisplay Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/displays-batch': put: tags: - Plan Displays summary: Create or Update Batch PlanDisplay description: 'Create or Update multiple PlanDisplay at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanDisplay parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanDisplay' text/json: schema: type: array items: $ref: '#/components/schemas/PlanDisplay' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanDisplay' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /plan-display-types: post: tags: - Plan Display Types summary: Create PlanDisplayType description: Creates a new PlanDisplayType operationId: CreatePlanDisplayType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanDisplayType' text/json: schema: $ref: '#/components/schemas/PlanDisplayType' application/*+json: schema: $ref: '#/components/schemas/PlanDisplayType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanDisplayTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanDisplayTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanDisplayTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Display Types summary: List PlanDisplayType description: 'Lists all PlanDisplayType ' operationId: ListPlanDisplayType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanDisplayTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanDisplayTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanDisplayTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plan-display-types/{displayType}': get: tags: - Plan Display Types summary: Get PlanDisplayType description: Gets PlanDisplayType operationId: GetPlanDisplayType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: displayType in: path description: Display Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanDisplayTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanDisplayTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanDisplayTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Display Types summary: Update PlanDisplayType description: Updates a specific PlanDisplayType. operationId: UpdatePlanDisplayType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: displayType in: path description: Display Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanDisplayType' text/json: schema: $ref: '#/components/schemas/PlanDisplayType' application/*+json: schema: $ref: '#/components/schemas/PlanDisplayType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanDisplayTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanDisplayTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanDisplayTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Display Types summary: Delete PlanDisplayType description: Deletes an PlanDisplayType operationId: DeletePlanDisplayType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: displayType in: path description: Display Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /plan-display-types-batch: put: tags: - Plan Display Types summary: Create or Update Batch PlanDisplayType description: 'Create or Update multiple PlanDisplayType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanDisplayType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanDisplayType' text/json: schema: type: array items: $ref: '#/components/schemas/PlanDisplayType' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanDisplayType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/lineages': post: tags: - Plan Lineages summary: Create PlanLineage description: Creates a new PlanLineage operationId: CreatePlanLineage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanLineage' text/json: schema: $ref: '#/components/schemas/PlanLineage' application/*+json: schema: $ref: '#/components/schemas/PlanLineage' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanLineageVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanLineageVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanLineageVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Lineages summary: List PlanLineage description: Lists all PlanLineage operationId: ListPlanLineage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanLineageListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanLineageListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanLineageListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Lineages summary: Create or Update Batch PlanLineage description: 'Create or Update multiple PlanLineage at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanLineage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanLineage' text/json: schema: type: array items: $ref: '#/components/schemas/PlanLineage' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanLineage' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/lineages/{planLineageID}': get: tags: - Plan Lineages summary: Get PlanLineage description: Gets PlanLineage operationId: GetPlanLineage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planLineageID in: path description: Plan Lineage ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanLineageVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanLineageVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanLineageVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Lineages summary: Update PlanLineage description: Updates a specific PlanLineage. operationId: UpdatePlanLineage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planLineageID in: path description: Plan Lineage ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanLineage' text/json: schema: $ref: '#/components/schemas/PlanLineage' application/*+json: schema: $ref: '#/components/schemas/PlanLineage' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanLineageVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanLineageVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanLineageVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Lineages summary: Delete PlanLineage description: Deletes an PlanLineage operationId: DeletePlanLineage parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planLineageID in: path description: Plan Lineage ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/lineages/{planLineageID}/details': post: tags: - Plan Lineage Details summary: Create PlanLineageDetail description: Creates a new PlanLineageDetail operationId: CreatePlanLineageDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planLineageID in: path description: Plan Lineage ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanLineageDetail' text/json: schema: $ref: '#/components/schemas/PlanLineageDetail' application/*+json: schema: $ref: '#/components/schemas/PlanLineageDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanLineageDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanLineageDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanLineageDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Lineage Details summary: List PlanLineageDetail description: Lists all PlanLineageDetail for the given planID and planLineageID operationId: ListPlanLineageDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planLineageID in: path description: Plan Lineage ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanLineageDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanLineageDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanLineageDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/lineages/{planLineageID}/details/{planLineageDetailKey}': get: tags: - Plan Lineage Details summary: Get PlanLineageDetail description: Gets PlanLineageDetail operationId: GetPlanLineageDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planLineageID in: path description: Plan Lineage ID required: true schema: type: string - name: planLineageDetailKey in: path description: PlanLineageDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanLineageDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanLineageDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanLineageDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Lineage Details summary: Update PlanLineageDetail description: Updates a specific PlanLineageDetail. operationId: UpdatePlanLineageDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planLineageID in: path description: Plan Lineage ID required: true schema: type: string - name: planLineageDetailKey in: path description: PlanLineageDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanLineageDetail' text/json: schema: $ref: '#/components/schemas/PlanLineageDetail' application/*+json: schema: $ref: '#/components/schemas/PlanLineageDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanLineageDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanLineageDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanLineageDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Lineage Details summary: Delete PlanLineageDetail description: Deletes an PlanLineageDetail operationId: DeletePlanLineageDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planLineageID in: path description: Plan Lineage ID required: true schema: type: string - name: planLineageDetailKey in: path description: PlanLineageDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/lineages/{planLineageID}/details-batch': put: tags: - Plan Lineage Details summary: Create or Update Batch PlanLineageDetail description: 'Create or Update multiple PlanLineageDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanLineageDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: planLineageID in: path description: Plan Lineage ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanLineageDetail' text/json: schema: type: array items: $ref: '#/components/schemas/PlanLineageDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanLineageDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/maximums': post: tags: - Plan Maximums summary: Create PlanMaximum description: Creates a new PlanMaximum operationId: CreatePlanMaximum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanMaximum' text/json: schema: $ref: '#/components/schemas/PlanMaximum' application/*+json: schema: $ref: '#/components/schemas/PlanMaximum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Maximums summary: List PlanMaximum description: Lists all PlanMaximum for the given planID and benefitCode operationId: ListPlanMaximum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}': get: tags: - Plan Maximums summary: Get PlanMaximum description: Gets PlanMaximum operationId: GetPlanMaximum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Maximums summary: Update PlanMaximum description: Updates a specific PlanMaximum. operationId: UpdatePlanMaximum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanMaximum' text/json: schema: $ref: '#/components/schemas/PlanMaximum' application/*+json: schema: $ref: '#/components/schemas/PlanMaximum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Maximums summary: Delete PlanMaximum description: Deletes an PlanMaximum operationId: DeletePlanMaximum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/maximums-batch': put: tags: - Plan Maximums summary: Create or Update Batch PlanMaximum description: 'Create or Update multiple PlanMaximum at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanMaximum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanMaximum' text/json: schema: type: array items: $ref: '#/components/schemas/PlanMaximum' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanMaximum' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/included-benefits/{includedBenefitCode}': post: tags: - Plan Benefit Maximums summary: Create PlanMaximumBenefit description: Creates a new PlanMaximumBenefit operationId: CreatePlanMaximumBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string - name: includedBenefitCode in: path description: Included Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Maximums summary: Get PlanMaximumBenefit description: Gets PlanMaximumBenefit operationId: GetPlanMaximumBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string - name: includedBenefitCode in: path description: Included Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumBenefitVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumBenefitVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumBenefitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Maximums summary: Delete PlanMaximumBenefit description: Deletes an PlanMaximumBenefit operationId: DeletePlanMaximumBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string - name: includedBenefitCode in: path description: Included Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/included-benefits': get: tags: - Plan Benefit Maximums summary: List PlanMaximumBenefit description: Lists all PlanMaximumBenefit for the given planID and benefitCode and maxID operationId: ListPlanMaximumBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumBenefitListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumBenefitListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumBenefitListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/included-benefits-batch': put: tags: - Plan Benefit Maximums summary: Create or Update Batch PlanMaximumBenefit description: 'Create or Update multiple PlanMaximumBenefit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanMaximumBenefit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanMaximumBenefit' text/json: schema: type: array items: $ref: '#/components/schemas/PlanMaximumBenefit' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanMaximumBenefit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/procedures': post: tags: - Plan Benefit Procedure Maximums summary: Create PlanMaximumProcedure description: Creates a new PlanMaximumProcedure operationId: CreatePlanMaximumProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanMaximumProcedure' text/json: schema: $ref: '#/components/schemas/PlanMaximumProcedure' application/*+json: schema: $ref: '#/components/schemas/PlanMaximumProcedure' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Procedure Maximums summary: List PlanMaximumProcedure description: Lists all PlanMaximumProcedure for the given planID and benefitCode and fromProcedure operationId: ListPlanMaximumProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumProcedureListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumProcedureListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumProcedureListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/procedures/{fromProcedure}': get: tags: - Plan Benefit Procedure Maximums summary: Get PlanMaximumProcedure description: Gets PlanMaximumProcedure operationId: GetPlanMaximumProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string - name: fromProcedure in: path description: From Procedure required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Benefit Procedure Maximums summary: Update PlanMaximumProcedure description: Updates a specific PlanMaximumProcedure. operationId: UpdatePlanMaximumProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string - name: fromProcedure in: path description: From Procedure required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanMaximumProcedure' text/json: schema: $ref: '#/components/schemas/PlanMaximumProcedure' application/*+json: schema: $ref: '#/components/schemas/PlanMaximumProcedure' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Procedure Maximums summary: Delete PlanMaximumProcedure description: Deletes an PlanMaximumProcedure operationId: DeletePlanMaximumProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string - name: fromProcedure in: path description: From Procedure required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/procedures-batch': put: tags: - Plan Benefit Procedure Maximums summary: Create or Update Batch PlanMaximumProcedure description: 'Create or Update multiple PlanMaximumProcedure at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanMaximumProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanMaximumProcedure' text/json: schema: type: array items: $ref: '#/components/schemas/PlanMaximumProcedure' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanMaximumProcedure' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/teeth': post: tags: - Plan Benefit Tooth Maximums summary: Create PlanMaximumTooth description: Creates a new PlanMaximumTooth operationId: CreatePlanMaximumTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanMaximumTooth' text/json: schema: $ref: '#/components/schemas/PlanMaximumTooth' application/*+json: schema: $ref: '#/components/schemas/PlanMaximumTooth' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumToothVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumToothVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumToothVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Benefit Tooth Maximums summary: List PlanMaximumTooth description: Lists all PlanMaximumTooth for the given planID and benefitCode and maxID operationId: ListPlanMaximumTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumToothListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumToothListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumToothListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/teeth/{toothNumber}': get: tags: - Plan Benefit Tooth Maximums summary: Get PlanMaximumTooth description: Gets PlanMaximumTooth operationId: GetPlanMaximumTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string - name: toothNumber in: path description: Tooth Number required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanMaximumToothVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanMaximumToothVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanMaximumToothVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Benefit Tooth Maximums summary: Delete PlanMaximumTooth description: Deletes an PlanMaximumTooth operationId: DeletePlanMaximumTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string - name: toothNumber in: path description: Tooth Number required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/teeth-batch': put: tags: - Plan Benefit Tooth Maximums summary: Create or Update Batch PlanMaximumTooth description: 'Create or Update multiple PlanMaximumTooth at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanMaximumTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanMaximumTooth' text/json: schema: type: array items: $ref: '#/components/schemas/PlanMaximumTooth' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanMaximumTooth' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/modifiers': post: tags: - Plan Modifiers summary: Create PlanModifier description: Creates a new PlanModifier operationId: CreatePlanModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanModifier' text/json: schema: $ref: '#/components/schemas/PlanModifier' application/*+json: schema: $ref: '#/components/schemas/PlanModifier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Modifiers summary: List PlanModifier description: Lists all PlanModifier for the given planID operationId: ListPlanModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanModifierListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanModifierListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanModifierListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/modifiers/{modifier}/effective-dates/{effectiveDate}': get: tags: - Plan Modifiers summary: Get PlanModifier description: Gets PlanModifier operationId: GetPlanModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: modifier in: path description: Modifier required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Modifiers summary: Update PlanModifier description: Updates a specific PlanModifier. operationId: UpdatePlanModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: modifier in: path description: Modifier required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanModifier' text/json: schema: $ref: '#/components/schemas/PlanModifier' application/*+json: schema: $ref: '#/components/schemas/PlanModifier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Modifiers summary: Delete PlanModifier description: Deletes an PlanModifier operationId: DeletePlanModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: modifier in: path description: Modifier required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/modifiers-batch': put: tags: - Plan Modifiers summary: Create or Update Batch PlanModifier description: 'Create or Update multiple PlanModifier at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanModifier' text/json: schema: type: array items: $ref: '#/components/schemas/PlanModifier' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanModifier' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/pre-existing-coverages': post: tags: - Plan Pre-existing Coverages summary: Create PlanPreEx description: Creates a new PlanPreEx operationId: CreatePlanPreEx parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanPreEx' text/json: schema: $ref: '#/components/schemas/PlanPreEx' application/*+json: schema: $ref: '#/components/schemas/PlanPreEx' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanPreExVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanPreExVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanPreExVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Pre-existing Coverages summary: List PlanPreEx description: Lists all PlanPreEx for the given planID operationId: ListPlanPreEx parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanPreExListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanPreExListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanPreExListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/pre-existing-coverages/{coverageType}': get: tags: - Plan Pre-existing Coverages summary: Get PlanPreEx description: Gets PlanPreEx operationId: GetPlanPreEx parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: coverageType in: path description: Coverage Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanPreExVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanPreExVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanPreExVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Pre-existing Coverages summary: Update PlanPreEx description: Updates a specific PlanPreEx. operationId: UpdatePlanPreEx parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: coverageType in: path description: Coverage Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanPreEx' text/json: schema: $ref: '#/components/schemas/PlanPreEx' application/*+json: schema: $ref: '#/components/schemas/PlanPreEx' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanPreExVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanPreExVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanPreExVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Pre-existing Coverages summary: Delete PlanPreEx description: Deletes an PlanPreEx operationId: DeletePlanPreEx parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: coverageType in: path description: Coverage Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/pre-existing-coverages-batch': put: tags: - Plan Pre-existing Coverages summary: Create or Update Batch PlanPreEx description: 'Create or Update multiple PlanPreEx at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanPreEx parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanPreEx' text/json: schema: type: array items: $ref: '#/components/schemas/PlanPreEx' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanPreEx' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/procedure-restrictions': post: tags: - Plan Procedure Age Restrictions summary: Create PlanProcedureAge description: Creates a new PlanProcedureAge operationId: CreatePlanProcedureAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanProcedureAge' text/json: schema: $ref: '#/components/schemas/PlanProcedureAge' application/*+json: schema: $ref: '#/components/schemas/PlanProcedureAge' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanProcedureAgeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanProcedureAgeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanProcedureAgeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Procedure Age Restrictions summary: List PlanProcedureAge description: Lists all PlanProcedureAge for the given planID operationId: ListPlanProcedureAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanProcedureAgeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanProcedureAgeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanProcedureAgeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/procedure-restrictions/{procedureAgeKey}': get: tags: - Plan Procedure Age Restrictions summary: Get PlanProcedureAge description: Gets PlanProcedureAge operationId: GetPlanProcedureAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: procedureAgeKey in: path description: ProcedureAgeKey required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanProcedureAgeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanProcedureAgeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanProcedureAgeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Procedure Age Restrictions summary: Update PlanProcedureAge description: Updates a specific PlanProcedureAge. operationId: UpdatePlanProcedureAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: procedureAgeKey in: path description: ProcedureAgeKey required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanProcedureAge' text/json: schema: $ref: '#/components/schemas/PlanProcedureAge' application/*+json: schema: $ref: '#/components/schemas/PlanProcedureAge' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanProcedureAgeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanProcedureAgeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanProcedureAgeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Procedure Age Restrictions summary: Delete PlanProcedureAge description: Deletes an PlanProcedureAge operationId: DeletePlanProcedureAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: procedureAgeKey in: path description: ProcedureAgeKey required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/procedure-restrictions-batch': put: tags: - Plan Procedure Age Restrictions summary: Create or Update Batch PlanProcedureAge description: 'Create or Update multiple PlanProcedureAge at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanProcedureAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanProcedureAge' text/json: schema: type: array items: $ref: '#/components/schemas/PlanProcedureAge' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanProcedureAge' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/procedure-restrictions/{procedureAgeKey}/modifiers': post: tags: - Plan Procedure Age Restriction Modifiers summary: Create PlanProcedureAgeModifier description: Creates a new PlanProcedureAgeModifier operationId: CreatePlanProcedureAgeModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: procedureAgeKey in: path description: ProcedureAgeKey required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifier' text/json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifier' application/*+json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanProcedureAgeModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Procedure Age Restriction Modifiers summary: List PlanProcedureAgeModifier description: Lists all PlanProcedureAgeModifier for the given procedureAgeKey operationId: ListPlanProcedureAgeModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: procedureAgeKey in: path description: ProcedureAgeKey required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanProcedureAgeModifierListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifierListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifierListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/procedure-restrictions/{procedureAgeKey}/modifiers/{planProcedureAgeModifierKey}': get: tags: - Plan Procedure Age Restriction Modifiers summary: Get PlanProcedureAgeModifier description: Gets PlanProcedureAgeModifier operationId: GetPlanProcedureAgeModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: procedureAgeKey in: path description: ProcedureAgeKey required: true schema: type: integer format: int32 - name: planProcedureAgeModifierKey in: path description: PlanProcedureAgeModifier Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanProcedureAgeModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Procedure Age Restriction Modifiers summary: Update PlanProcedureAgeModifier description: Updates a specific PlanProcedureAgeModifier. operationId: UpdatePlanProcedureAgeModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: procedureAgeKey in: path description: ProcedureAgeKey required: true schema: type: integer format: int32 - name: planProcedureAgeModifierKey in: path description: PlanProcedureAgeModifier Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifier' text/json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifier' application/*+json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanProcedureAgeModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanProcedureAgeModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Procedure Age Restriction Modifiers summary: Delete PlanProcedureAgeModifier description: Deletes an PlanProcedureAgeModifier operationId: DeletePlanProcedureAgeModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: procedureAgeKey in: path description: ProcedureAgeKey required: true schema: type: integer format: int32 - name: planProcedureAgeModifierKey in: path description: PlanProcedureAgeModifier Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plans/{planID}/procedure-restrictions/{procedureAgeKey}/modifiers-batch': put: tags: - Plan Procedure Age Restriction Modifiers summary: Create or Update Batch PlanProcedureAgeModifier description: 'Create or Update multiple PlanProcedureAgeModifier at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanProcedureAgeModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: procedureAgeKey in: path description: ProcedureAgeKey required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanProcedureAgeModifier' text/json: schema: type: array items: $ref: '#/components/schemas/PlanProcedureAgeModifier' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanProcedureAgeModifier' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /plan-relationship-age-restrictions: post: tags: - Plan Relationship Age Restrictions summary: Create PlanRelationshipAge description: Creates a new PlanRelationshipAge operationId: CreatePlanRelationshipAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanRelationshipAge' text/json: schema: $ref: '#/components/schemas/PlanRelationshipAge' application/*+json: schema: $ref: '#/components/schemas/PlanRelationshipAge' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanRelationshipAgeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanRelationshipAgeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanRelationshipAgeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Relationship Age Restrictions summary: List PlanRelationshipAge description: Lists all PlanRelationshipAge for the given planID operationId: ListPlanRelationshipAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: query description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanRelationshipAgeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanRelationshipAgeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanRelationshipAgeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plan-relationship-age-restrictions/{planRelationshipAgeKey}': get: tags: - Plan Relationship Age Restrictions summary: Get PlanRelationshipAge description: Gets PlanRelationshipAge operationId: GetPlanRelationshipAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planRelationshipAgeKey in: path description: PlanRelationshipAge Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanRelationshipAgeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanRelationshipAgeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanRelationshipAgeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Relationship Age Restrictions summary: Update PlanRelationshipAge description: Updates a specific PlanRelationshipAge. operationId: UpdatePlanRelationshipAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planRelationshipAgeKey in: path description: PlanRelationshipAge Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanRelationshipAge' text/json: schema: $ref: '#/components/schemas/PlanRelationshipAge' application/*+json: schema: $ref: '#/components/schemas/PlanRelationshipAge' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanRelationshipAgeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanRelationshipAgeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanRelationshipAgeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Relationship Age Restrictions summary: Delete PlanRelationshipAge description: Deletes an PlanRelationshipAge operationId: DeletePlanRelationshipAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planRelationshipAgeKey in: path description: PlanRelationshipAge Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /plan-relationship-age-restrictions-batch: put: tags: - Plan Relationship Age Restrictions summary: Create or Update Batch PlanRelationshipAge description: 'Create or Update multiple PlanRelationshipAge at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanRelationshipAge parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanRelationshipAge' text/json: schema: type: array items: $ref: '#/components/schemas/PlanRelationshipAge' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanRelationshipAge' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /plans: post: tags: - Plans summary: Create Plan description: Creates a new Plan operationId: CreatePlans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Plans' text/json: schema: $ref: '#/components/schemas/Plans' application/*+json: schema: $ref: '#/components/schemas/Plans' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlansVBAResponse' application/json: schema: $ref: '#/components/schemas/PlansVBAResponse' text/json: schema: $ref: '#/components/schemas/PlansVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plans summary: List Plans description: Lists all Plans with option to filter by Plan Type. operationId: ListPlans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planType in: query description: Plan Type schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlansListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlansListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlansListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /plans-copy: post: tags: - Plans - Adv. Benefits summary: Copy Plan description: 'Copies an existing plan. This copy can be to a completely new Plan ID, or to overwrite an existing Plan ID.' operationId: CopyPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanCopy' text/json: schema: $ref: '#/components/schemas/PlanCopy' application/*+json: schema: $ref: '#/components/schemas/PlanCopy' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlansVBAResponse' application/json: schema: $ref: '#/components/schemas/PlansVBAResponse' text/json: schema: $ref: '#/components/schemas/PlansVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/plans/{planID}': get: tags: - Plans summary: Get Plan description: Gets a specific Plan operationId: GetPlans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlansVBAResponse' application/json: schema: $ref: '#/components/schemas/PlansVBAResponse' text/json: schema: $ref: '#/components/schemas/PlansVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plans summary: Update Plans description: Updates a specific Plans. operationId: UpdatePlans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Plans' text/json: schema: $ref: '#/components/schemas/Plans' application/*+json: schema: $ref: '#/components/schemas/Plans' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlansVBAResponse' application/json: schema: $ref: '#/components/schemas/PlansVBAResponse' text/json: schema: $ref: '#/components/schemas/PlansVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plans summary: Delete Plans description: Deletes an Plans operationId: DeletePlans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /plans-batch: put: tags: - Plans summary: Create or Update Batch Plans description: 'Create or Update multiple Plans at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Plans' text/json: schema: type: array items: $ref: '#/components/schemas/Plans' application/*+json: schema: type: array items: $ref: '#/components/schemas/Plans' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /plan-types: post: tags: - Plan Types summary: Create PlanType description: Creates a new PlanType operationId: CreatePlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanType' text/json: schema: $ref: '#/components/schemas/PlanType' application/*+json: schema: $ref: '#/components/schemas/PlanType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Plan Types summary: List PlanType description: 'Lists all PlanType ' operationId: ListPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/plan-types/{planType}': get: tags: - Plan Types summary: Get PlanType description: Gets PlanType operationId: GetPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Plan Types summary: Update PlanType description: Updates a specific PlanType. operationId: UpdatePlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PlanType' text/json: schema: $ref: '#/components/schemas/PlanType' application/*+json: schema: $ref: '#/components/schemas/PlanType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PlanTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PlanTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PlanTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Plan Types summary: Delete PlanType description: Deletes an PlanType operationId: DeletePlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /plan-types-batch: put: tags: - Plan Types summary: Create or Update Batch PlanType description: 'Create or Update multiple PlanType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanType' text/json: schema: type: array items: $ref: '#/components/schemas/PlanType' application/*+json: schema: type: array items: $ref: '#/components/schemas/PlanType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /policy-forfeiture-exts: post: tags: - Policy Forfeiture Ext summary: Create PolicyForfeitureExt description: Creates a new PolicyForfeitureExt operationId: CreatePolicyForfeitureExt parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyForfeitureExt' text/json: schema: $ref: '#/components/schemas/PolicyForfeitureExt' application/*+json: schema: $ref: '#/components/schemas/PolicyForfeitureExt' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PolicyForfeitureExtVBAResponse' application/json: schema: $ref: '#/components/schemas/PolicyForfeitureExtVBAResponse' text/json: schema: $ref: '#/components/schemas/PolicyForfeitureExtVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Policy Forfeiture Ext summary: List PolicyForfeitureExt description: Lists all PolicyForfeitureExt operationId: ListPolicyForfeitureExt parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PolicyForfeitureExtListVBAResponse' application/json: schema: $ref: '#/components/schemas/PolicyForfeitureExtListVBAResponse' text/json: schema: $ref: '#/components/schemas/PolicyForfeitureExtListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/policy-forfeiture-exts/{PolicyForfeitureExt_Key}': get: tags: - Policy Forfeiture Ext summary: Get PolicyForfeitureExt description: Gets PolicyForfeitureExt operationId: GetPolicyForfeitureExt parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: PolicyForfeitureExt_Key in: path description: PolicyForfeitureExt Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PolicyForfeitureExtVBAResponse' application/json: schema: $ref: '#/components/schemas/PolicyForfeitureExtVBAResponse' text/json: schema: $ref: '#/components/schemas/PolicyForfeitureExtVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Policy Forfeiture Ext summary: Update PolicyForfeitureExt description: Updates a specific PolicyForfeitureExt. operationId: UpdatePolicyForfeitureExt parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: PolicyForfeitureExt_Key in: path description: PolicyForfeitureExt Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyForfeitureExt' text/json: schema: $ref: '#/components/schemas/PolicyForfeitureExt' application/*+json: schema: $ref: '#/components/schemas/PolicyForfeitureExt' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PolicyForfeitureExtVBAResponse' application/json: schema: $ref: '#/components/schemas/PolicyForfeitureExtVBAResponse' text/json: schema: $ref: '#/components/schemas/PolicyForfeitureExtVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Policy Forfeiture Ext summary: Delete PolicyForfeitureExt description: Deletes an PolicyForfeitureExt operationId: DeletePolicyForfeitureExt parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: PolicyForfeitureExt_Key in: path description: PolicyForfeitureExt Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /policy-forfeiture-exts-batch: put: tags: - Policy Forfeiture Ext summary: Create or Update Batch PolicyForfeitureExt description: 'Create or Update multiple PolicyForfeitureExt at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPolicyForfeitureExt parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PolicyForfeitureExt' text/json: schema: type: array items: $ref: '#/components/schemas/PolicyForfeitureExt' application/*+json: schema: type: array items: $ref: '#/components/schemas/PolicyForfeitureExt' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /policy-forfeiture-ext-details: get: tags: - Policy Forfeiture Ext Details summary: List PolicyForfeitureExtDetail description: Lists all PolicyForfeitureExtDetail operationId: ListPolicyForfeitureExtDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PolicyForfeitureExtDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/PolicyForfeitureExtDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/PolicyForfeitureExtDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/policy-forfeiture-ext-details/{policyForfeitureExtDetailKey}': get: tags: - Policy Forfeiture Ext Details summary: Get PolicyForfeitureExtDetail description: Gets PolicyForfeitureExtDetail operationId: GetPolicyForfeitureExtDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: policyForfeitureExtDetailKey in: path description: PolicyForfeitureExtDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PolicyForfeitureExtDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/PolicyForfeitureExtDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/PolicyForfeitureExtDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /policy-statuses: post: tags: - Policy Statuses summary: Create PolicyStatus description: Creates a new PolicyStatus operationId: CreatePolicyStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyStatus' text/json: schema: $ref: '#/components/schemas/PolicyStatus' application/*+json: schema: $ref: '#/components/schemas/PolicyStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PolicyStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/PolicyStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/PolicyStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Policy Statuses summary: List PolicyStatus description: 'Lists all PolicyStatus ' operationId: ListPolicyStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PolicyStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/PolicyStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/PolicyStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/policy-statuses/{policyStatus}': get: tags: - Policy Statuses summary: Get PolicyStatus description: Gets PolicyStatus operationId: GetPolicyStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: policyStatus in: path description: Policy Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PolicyStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/PolicyStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/PolicyStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Policy Statuses summary: Update PolicyStatus description: Updates a specific PolicyStatus. operationId: UpdatePolicyStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: policyStatus in: path description: Policy Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyStatus' text/json: schema: $ref: '#/components/schemas/PolicyStatus' application/*+json: schema: $ref: '#/components/schemas/PolicyStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PolicyStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/PolicyStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/PolicyStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Policy Statuses summary: Delete PolicyStatus description: Deletes an PolicyStatus operationId: DeletePolicyStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: policyStatus in: path description: Policy Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /policy-statuses-batch: put: tags: - Policy Statuses summary: Create or Update Batch PolicyStatus description: 'Create or Update multiple PolicyStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPolicyStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PolicyStatus' text/json: schema: type: array items: $ref: '#/components/schemas/PolicyStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/PolicyStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /practice-types: post: tags: - Provider Practice Types summary: Create PracticeType description: Creates a new PracticeType operationId: CreatePracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PracticeType' text/json: schema: $ref: '#/components/schemas/PracticeType' application/*+json: schema: $ref: '#/components/schemas/PracticeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PracticeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PracticeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PracticeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Practice Types summary: List PracticeType description: Lists all PracticeType operationId: ListPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PracticeTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PracticeTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PracticeTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/practice-types/{practiceType}': get: tags: - Provider Practice Types summary: Get PracticeType description: Gets PracticeType operationId: GetPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: practiceType in: path description: Practice Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PracticeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PracticeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PracticeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Practice Types summary: Update PracticeType description: Updates a specific PracticeType. operationId: UpdatePracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: practiceType in: path description: Practice Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PracticeType' text/json: schema: $ref: '#/components/schemas/PracticeType' application/*+json: schema: $ref: '#/components/schemas/PracticeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PracticeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PracticeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PracticeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Practice Types summary: Delete PracticeType description: Deletes an PracticeType operationId: DeletePracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: practiceType in: path description: Practice Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /practice-types-batch: put: tags: - Provider Practice Types summary: Create or Update Batch PracticeType description: 'Create or Update multiple PracticeType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPracticeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PracticeType' text/json: schema: type: array items: $ref: '#/components/schemas/PracticeType' application/*+json: schema: type: array items: $ref: '#/components/schemas/PracticeType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-distributions: post: tags: - Premium Distributions summary: Create PremDistribution description: Creates a new PremDistribution operationId: CreatePremDistribution parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremDistribution' text/json: schema: $ref: '#/components/schemas/PremDistribution' application/*+json: schema: $ref: '#/components/schemas/PremDistribution' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremDistributionVBAResponse' application/json: schema: $ref: '#/components/schemas/PremDistributionVBAResponse' text/json: schema: $ref: '#/components/schemas/PremDistributionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Distributions summary: List PremDistribution description: Lists all PremDistribution operationId: ListPremDistribution parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremDistributionListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremDistributionListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremDistributionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-distributions/{premDistributionKey}': get: tags: - Premium Distributions summary: Get PremDistribution description: Gets PremDistribution operationId: GetPremDistribution parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premDistributionKey in: path description: PremDistribution Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremDistributionVBAResponse' application/json: schema: $ref: '#/components/schemas/PremDistributionVBAResponse' text/json: schema: $ref: '#/components/schemas/PremDistributionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Distributions summary: Update PremDistribution description: Updates a specific PremDistribution. operationId: UpdatePremDistribution parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premDistributionKey in: path description: PremDistribution Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremDistribution' text/json: schema: $ref: '#/components/schemas/PremDistribution' application/*+json: schema: $ref: '#/components/schemas/PremDistribution' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremDistributionVBAResponse' application/json: schema: $ref: '#/components/schemas/PremDistributionVBAResponse' text/json: schema: $ref: '#/components/schemas/PremDistributionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Distributions summary: Delete PremDistribution description: Deletes an PremDistribution operationId: DeletePremDistribution parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premDistributionKey in: path description: PremDistribution Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-distributions-batch: put: tags: - Premium Distributions summary: Create or Update Batch PremDistribution description: 'Create or Update multiple PremDistribution at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremDistribution parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremDistribution' text/json: schema: type: array items: $ref: '#/components/schemas/PremDistribution' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremDistribution' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-distributions-generate/{groupId}/{asOfDate}': post: tags: - Premium Distributions - Adv. Billing summary: Create Premium Distributions description: Generate the Premium Distributions for the selected Group and As of Date. operationId: GeneratePremDistribution parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupId in: path description: Group ID required: true schema: type: string - name: asOfDate in: path description: As of Date required: true schema: type: string format: date-time responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/premium-distributions-generate-check/{payeeId}/{payorId}/{accountKey}/{checkNumber}': post: tags: - Premium Distributions - Adv. Billing summary: Create Premium Distributions Checks description: Generate the Premium Distribution Checks for the selected Payor and Payee. operationId: GeneratePremDistributionCheck parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: payeeId in: path description: Payee ID required: true schema: type: string - name: payorId in: path description: Payor ID required: true schema: type: string - name: accountKey in: path description: Account Key required: true schema: type: integer format: int32 - name: checkNumber in: path description: Check Number required: true schema: type: string responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/premium-distributions-available/{asOfDate}': get: tags: - Premium Distributions summary: List of Distribution by Group that have not been distributed. description: List of Distribution by Group that have not been distributed. operationId: ListPremDistributionAvailable parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: asOfDate in: path description: As of Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GetPremDistributionListResultListVBAResponse' application/json: schema: $ref: '#/components/schemas/GetPremDistributionListResultListVBAResponse' text/json: schema: $ref: '#/components/schemas/GetPremDistributionListResultListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /premium-invoices: post: tags: - Premium Invoices summary: Create PremInvoice description: Creates a new PremInvoice operationId: CreatePremInvoice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoice' text/json: schema: $ref: '#/components/schemas/PremInvoice' application/*+json: schema: $ref: '#/components/schemas/PremInvoice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Invoices summary: List PremInvoice description: Lists all PremInvoice. operationId: ListPremInvoice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-invoices-slim: get: tags: - Premium Invoices summary: List PremInvoiceSlim description: Gets a 'Slim' list of PremInvoices. The Slim model has a limited subset of fields intended for quick loading. You may provide the GroupID and/or Invoice Year to filter the list to include only those Invoices in which the Group/Invoice Year match an invoice with the same Group/Invoice Year wihtin the PremInvoiceSubscriber and PremInvoiceSelfAdmin tables. operationId: ListPremInvoiceSlim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupId in: query description: Group ID schema: type: string - name: invoiceYear in: query description: Invoice Year schema: type: integer format: int32 default: -1 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSlimListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSlimListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSlimListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}': get: tags: - Premium Invoices summary: Get PremInvoice description: Gets PremInvoice operationId: GetPremInvoice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Invoices summary: Update PremInvoice description: Updates a specific PremInvoice. operationId: UpdatePremInvoice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoice' text/json: schema: $ref: '#/components/schemas/PremInvoice' application/*+json: schema: $ref: '#/components/schemas/PremInvoice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Invoices summary: Delete PremInvoice description: Deletes an PremInvoice operationId: DeletePremInvoice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-invoices-batch: put: tags: - Premium Invoices summary: Create or Update Batch PremInvoice description: 'Create or Update multiple PremInvoice at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremInvoice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremInvoice' text/json: schema: type: array items: $ref: '#/components/schemas/PremInvoice' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremInvoice' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}/summary': get: tags: - Premium Invoices summary: Get PremInvoice Summary description: 'Gets PremInvoice Summary for the specified invoice. First PremInvoiceSelfAdmin table is checked for the invoice key, if found the values are aggregated from come from PremInvoiceSelfAdmin; if the invoice key is not found in PremInvoiceSelfAdmin, the PremInvoiceSubscriber table is checked. If not present in either table, an error is returned.' operationId: GetPremInvoiceSummary parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceGroupSummaryVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceGroupSummaryVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceGroupSummaryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-invoices-group-summary: get: tags: - Premium Invoices summary: Get PremInvoice Group Summary description: 'Gets PremInvoice Summary for the specified group id and invoice year. First PremInvoiceSelfAdmin table is checked for the group id, if found the values are aggregated from come from PremInvoiceSelfAdmin; if the group is not found in PremInvoiceSelfAdmin, the PremInvoiceSubscriber table is checked for this group. If not present in either table, an error is returned.' operationId: GetPremInvoiceGroupSummary parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupId in: query description: Group ID required: true schema: type: string - name: invoiceYear in: query description: Invoice Year required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceGroupSummaryVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceGroupSummaryVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceGroupSummaryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-invoice-apply-payment-sub: post: tags: - Premium Invoices - Adv. Billing summary: PremInvoice Apply Payments by Subscriber description: PremInvoice Apply Payments by Subscriber operationId: PremInvoiceApplyPaymentSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceApplyPayment' text/json: schema: $ref: '#/components/schemas/PremInvoiceApplyPayment' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceApplyPayment' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /premium-invoice-apply-payment-adj: post: tags: - Premium Invoices - Adv. Billing summary: PremInvoice Apply Payments by Header Adjustment description: PremInvoice Apply Payments by Header Adjustment operationId: PremInvoiceApplyPaymentHeaderAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceApplyPayment' text/json: schema: $ref: '#/components/schemas/PremInvoiceApplyPayment' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceApplyPayment' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /premium-invoice-apply-payment-sub-plan-type: post: tags: - Premium Invoices - Adv. Billing summary: PremInvoice Apply Payments by Subscriber and Plan Type description: PremInvoice Apply Payments by Subscriber and Plan Type operationId: PremInvoiceApplyPaymentSubscriberPlanType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceApplyPayment' text/json: schema: $ref: '#/components/schemas/PremInvoiceApplyPayment' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceApplyPayment' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /premium-invoice-apply-payment-sub-payor_id: post: tags: - Premium Invoices - Adv. Billing summary: PremInvoice Apply Payments by Subscriber and Payor ID description: PremInvoice Apply Payments by Subscriber and Payor ID operationId: PremInvoiceApplyPaymentSubscriberPayorID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceApplyPayment' text/json: schema: $ref: '#/components/schemas/PremInvoiceApplyPayment' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceApplyPayment' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/premium-invoices/{invoiceKey}/auto-apply': post: tags: - Premium Invoices - Adv. Billing summary: PremInvoice Auto-Apply description: Auto-Apply all payements to the selected invoice. operationId: PremInvoiceAutoApply parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/premium-invoices/{invoiceKey}/auto-apply-self-admin': post: tags: - Premium Invoices - Adv. Billing summary: PremInvoice Auto-Apply for Self-Admin description: Auto-Apply all payements to the selected Self-Admin invoice. operationId: PremInvoiceAutoApplySelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /premium-invoice-adjustments-received: post: tags: - Premium Invoice Adjustments Received summary: Create PremInvoiceAdjReceived description: Creates a new PremInvoiceAdjReceived operationId: CreatePremInvoiceAdjReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceived' text/json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceived' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceived' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceAdjReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Invoice Adjustments Received summary: List PremInvoiceAdjReceived description: Lists all PremInvoiceAdjReceived operationId: ListPremInvoiceAdjReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceAdjReceivedListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceivedListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceivedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoice-adjustments-received/{premInvoiceAdjReceivedKey}': get: tags: - Premium Invoice Adjustments Received summary: Get PremInvoiceAdjReceived description: Gets PremInvoiceAdjReceived operationId: GetPremInvoiceAdjReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premInvoiceAdjReceivedKey in: path description: PremInvoiceAdjReceived Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceAdjReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Invoice Adjustments Received summary: Update PremInvoiceAdjReceived description: Updates a specific PremInvoiceAdjReceived. operationId: UpdatePremInvoiceAdjReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premInvoiceAdjReceivedKey in: path description: PremInvoiceAdjReceived Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceived' text/json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceived' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceived' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceAdjReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceAdjReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Invoice Adjustments Received summary: Delete PremInvoiceAdjReceived description: Deletes an PremInvoiceAdjReceived operationId: DeletePremInvoiceAdjReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premInvoiceAdjReceivedKey in: path description: PremInvoiceAdjReceived Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-invoice-adjustments-received-batch: put: tags: - Premium Invoice Adjustments Received summary: Create or Update Batch PremInvoiceAdjReceived description: 'Create or Update multiple PremInvoiceAdjReceived at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremInvoiceAdjReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceAdjReceived' text/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceAdjReceived' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceAdjReceived' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-invoice-adjustments: post: tags: - Premium Invoice Adjustments summary: Create PremInvoiceAdjustment description: Creates a new PremInvoiceAdjustment operationId: CreatePremInvoiceAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceAdjustment' text/json: schema: $ref: '#/components/schemas/PremInvoiceAdjustment' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceAdjustment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceAdjustmentVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceAdjustmentVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceAdjustmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Invoice Adjustments summary: List PremInvoiceAdjustment description: Lists all PremInvoiceAdjustment. Provide invoiceKey query parameter to filter by invoice. Omit the invoiceKey query parameter to filter by unassigned. operationId: ListPremInvoiceAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: query description: Invoice Key schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceAdjustmentListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceAdjustmentListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceAdjustmentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoice-adjustments/{invoiceAdjustmentKey}': get: tags: - Premium Invoice Adjustments summary: Get PremInvoiceAdjustment description: Gets PremInvoiceAdjustment operationId: GetPremInvoiceAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceAdjustmentKey in: path description: InvoiceAdjustment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceAdjustmentVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceAdjustmentVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceAdjustmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Invoice Adjustments summary: Update PremInvoiceAdjustment description: Updates a specific PremInvoiceAdjustment. operationId: UpdatePremInvoiceAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceAdjustmentKey in: path description: InvoiceAdjustment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceAdjustment' text/json: schema: $ref: '#/components/schemas/PremInvoiceAdjustment' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceAdjustment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceAdjustmentVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceAdjustmentVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceAdjustmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Invoice Adjustments summary: Delete PremInvoiceAdjustment description: Deletes an PremInvoiceAdjustment operationId: DeletePremInvoiceAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceAdjustmentKey in: path description: InvoiceAdjustment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-invoice-adjustments-batch: put: tags: - Premium Invoice Adjustments summary: Create or Update Batch PremInvoiceAdjustment description: 'Create or Update multiple PremInvoiceAdjustment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremInvoiceAdjustment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceAdjustment' text/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceAdjustment' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceAdjustment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-invoices/individual: get: tags: - PremInvoiceList summary: Retrieve Premium Invoices for Individual Subscribers description: Retrieves a list of Premium Invoices for individual subscribers. operationId: ListPremInvoicesIndividual parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceDate in: query description: The date that the invoice was generated. schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceIndividualListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceIndividualListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceIndividualListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-invoice-payments: post: tags: - Premium Invoice Payments summary: Create PremInvoicePayment description: Creates a new PremInvoicePayment operationId: CreatePremInvoicePayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoicePayment' text/json: schema: $ref: '#/components/schemas/PremInvoicePayment' application/*+json: schema: $ref: '#/components/schemas/PremInvoicePayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoicePaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoicePaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoicePaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Invoice Payments summary: List PremInvoicePayment description: Lists all PremInvoicePayment operationId: ListPremInvoicePayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoicePaymentListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoicePaymentListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoicePaymentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoice-payments/{invoiceKey}/{premPaymentKey}': get: tags: - Premium Invoice Payments summary: Get PremInvoicePayment description: Gets PremInvoicePayment operationId: GetPremInvoicePayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoicePaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoicePaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoicePaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Invoice Payments summary: Update PremInvoicePayment description: Updates a specific PremInvoicePayment. operationId: UpdatePremInvoicePayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoicePayment' text/json: schema: $ref: '#/components/schemas/PremInvoicePayment' application/*+json: schema: $ref: '#/components/schemas/PremInvoicePayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoicePaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoicePaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoicePaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Invoice Payments summary: Delete PremInvoicePayment description: Deletes an PremInvoicePayment operationId: DeletePremInvoicePayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoice-payments-ext/{invoiceKey}': get: tags: - Premium Invoice Payments summary: List PremInvoicePayment Extended description: Lists PremInvoicePayment Extended objects which include invoice posted payments and payment applied fields. operationId: ListPremInvoicePaymentExt parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: invoiceYear in: query description: Invoice Year schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoicePayment_ExtListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoicePayment_ExtListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoicePayment_ExtListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-invoice-payments-batch: put: tags: - Premium Invoice Payments summary: Create or Update Batch PremInvoicePayment description: 'Create or Update multiple PremInvoicePayment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremInvoicePayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremInvoicePayment' text/json: schema: type: array items: $ref: '#/components/schemas/PremInvoicePayment' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremInvoicePayment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-invoices-received: post: tags: - Premium Invoices Received summary: Create PremInvoiceReceived description: Creates a new PremInvoiceReceived operationId: CreatePremInvoiceReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceReceived' text/json: schema: $ref: '#/components/schemas/PremInvoiceReceived' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceReceived' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Invoices Received summary: List PremInvoiceReceived description: Lists all PremInvoiceReceived for the given invoiceKey and groupID and divisionID and subscriberID and premRateKey operationId: ListPremInvoiceReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: query description: Invoice Key required: true schema: type: integer format: int32 - name: groupID in: query description: Group ID required: true schema: type: string - name: divisionID in: query description: Division ID required: true schema: type: string - name: subscriberID in: query description: Subscriber ID required: true schema: type: string - name: premRateKey in: query description: PremRate Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceReceivedListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceReceivedListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceReceivedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices-received/{premInvoiceReceivedKey}': get: tags: - Premium Invoices Received summary: Get PremInvoiceReceived description: Gets PremInvoiceReceived operationId: GetPremInvoiceReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premInvoiceReceivedKey in: path description: PremInvoiceReceived Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Invoices Received summary: Update PremInvoiceReceived description: Updates a specific PremInvoiceReceived. operationId: UpdatePremInvoiceReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premInvoiceReceivedKey in: path description: PremInvoiceReceived Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceReceived' text/json: schema: $ref: '#/components/schemas/PremInvoiceReceived' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceReceived' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Invoices Received summary: Delete PremInvoiceReceived description: Deletes an PremInvoiceReceived operationId: DeletePremInvoiceReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premInvoiceReceivedKey in: path description: PremInvoiceReceived Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-invoices-received-batch: put: tags: - Premium Invoices Received summary: Create or Update Batch PremInvoiceReceived description: 'Create or Update multiple PremInvoiceReceived at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremInvoiceReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceReceived' text/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceReceived' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceReceived' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}/self-admin': post: tags: - Premium Invoices Self-Admin summary: Create PremInvoiceSelfAdmin description: Creates a new PremInvoiceSelfAdmin operationId: CreatePremInvoiceSelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdmin' text/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdmin' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdmin' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Invoices Self-Admin summary: List PremInvoiceSelfAdmin description: Lists all PremInvoiceSelfAdmin for the given invoiceKey operationId: ListPremInvoiceSelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}/self-admin/{premInvoiceSelfAdminKey}': get: tags: - Premium Invoices Self-Admin summary: Get PremInvoiceSelfAdmin description: Gets PremInvoiceSelfAdmin operationId: GetPremInvoiceSelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: premInvoiceSelfAdminKey in: path description: PremInvoiceSelfAdmin Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Invoices Self-Admin summary: Update PremInvoiceSelfAdmin description: Updates a specific PremInvoiceSelfAdmin. operationId: UpdatePremInvoiceSelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: premInvoiceSelfAdminKey in: path description: PremInvoiceSelfAdmin Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdmin' text/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdmin' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdmin' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Invoices Self-Admin summary: Delete PremInvoiceSelfAdmin description: Deletes an PremInvoiceSelfAdmin operationId: DeletePremInvoiceSelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: premInvoiceSelfAdminKey in: path description: PremInvoiceSelfAdmin Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}/self-admin-batch': put: tags: - Premium Invoices Self-Admin summary: Create or Update Batch PremInvoiceSelfAdmin description: 'Create or Update multiple PremInvoiceSelfAdmin at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremInvoiceSelfAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceSelfAdmin' text/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceSelfAdmin' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceSelfAdmin' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices-self-admin/{premInvoiceSelfAdminKey}/received': post: tags: - Premium Invoices Self-Admin Received summary: Create PremInvoiceSelfAdminReceived description: Creates a new PremInvoiceSelfAdminReceived operationId: CreatePremInvoiceSelfAdminReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premInvoiceSelfAdminKey in: path description: PremInvoiceSelfAdmin Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceived' text/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceived' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceived' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Invoices Self-Admin Received summary: List PremInvoiceSelfAdminReceived description: Lists all PremInvoiceSelfAdminReceived for the given premInvoiceSelfAdminKey operationId: ListPremInvoiceSelfAdminReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premInvoiceSelfAdminKey in: path description: PremInvoiceSelfAdmin Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceivedListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceivedListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceivedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices-self-admin/{premInvoiceSelfAdminKey}/received/{premInvoiceSelfAdminReceivedKey}': get: tags: - Premium Invoices Self-Admin Received summary: Get PremInvoiceSelfAdminReceived description: Gets PremInvoiceSelfAdminReceived operationId: GetPremInvoiceSelfAdminReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premInvoiceSelfAdminKey in: path description: PremInvoiceSelfAdmin Key required: true schema: type: integer format: int32 - name: premInvoiceSelfAdminReceivedKey in: path description: PremInvoiceSelfAdminReceived Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Invoices Self-Admin Received summary: Update PremInvoiceSelfAdminReceived description: Updates a specific PremInvoiceSelfAdminReceived. operationId: UpdatePremInvoiceSelfAdminReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premInvoiceSelfAdminKey in: path description: PremInvoiceSelfAdmin Key required: true schema: type: integer format: int32 - name: premInvoiceSelfAdminReceivedKey in: path description: PremInvoiceSelfAdminReceived Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceived' text/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceived' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceived' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceivedVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceivedVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSelfAdminReceivedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Invoices Self-Admin Received summary: Delete PremInvoiceSelfAdminReceived description: Deletes an PremInvoiceSelfAdminReceived operationId: DeletePremInvoiceSelfAdminReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premInvoiceSelfAdminKey in: path description: PremInvoiceSelfAdmin Key required: true schema: type: integer format: int32 - name: premInvoiceSelfAdminReceivedKey in: path description: PremInvoiceSelfAdminReceived Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices-self-admin/{premInvoiceSelfAdminKey}/received-batch': put: tags: - Premium Invoices Self-Admin Received summary: Create or Update Batch PremInvoiceSelfAdminReceived description: 'Create or Update multiple PremInvoiceSelfAdminReceived at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremInvoiceSelfAdminReceived parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premInvoiceSelfAdminKey in: path description: PremInvoiceSelfAdmin Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceSelfAdminReceived' text/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceSelfAdminReceived' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceSelfAdminReceived' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}/subscribers': post: tags: - Premium Invoice Subscribers summary: Create PremInvoiceSubscriber description: Creates a new PremInvoiceSubscriber operationId: CreatePremInvoiceSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriber' text/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriber' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceSubscriber' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Invoice Subscribers summary: List PremInvoiceSubscriber description: Lists all PremInvoiceSubscriber for the given invoiceKey operationId: ListPremInvoiceSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSubscriberListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}/subscribers/{groupID}/{divisionID}/{subscriberID}': get: tags: - Premium Invoice Subscribers summary: Get PremInvoiceSubscriber description: Gets PremInvoiceSubscriber operationId: GetPremInvoiceSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Invoice Subscribers summary: Update PremInvoiceSubscriber description: Updates a specific PremInvoiceSubscriber. operationId: UpdatePremInvoiceSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriber' text/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriber' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceSubscriber' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Invoice Subscribers summary: Delete PremInvoiceSubscriber description: Deletes an PremInvoiceSubscriber operationId: DeletePremInvoiceSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}/subscribers-batch': put: tags: - Premium Invoice Subscribers summary: Create or Update Batch PremInvoiceSubscriber description: 'Create or Update multiple PremInvoiceSubscriber at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremInvoiceSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceSubscriber' text/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceSubscriber' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceSubscriber' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}/subscribers/{subscriberID}/history': get: tags: - Premium Invoice Subscribers summary: List PremInvoiceSubscriberHistory description: Lists all PremInvoiceSubscriber History for the given invoiceKey and Subscriber ID operationId: ListPremInvoiceSubscriberHistory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_PremInvoiceSubscriberHistoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_PremInvoiceSubscriberHistoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_PremInvoiceSubscriberHistoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}/subscriber-calculations': get: tags: - Premium Invoice Subscribers summary: List of Premium Invoice Calculations by Subscriber description: 'Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.' operationId: ListPremInvoiceSubscriberCalculations parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GetPremInvoiceSubscriberListResultListVBAResponse' application/json: schema: $ref: '#/components/schemas/GetPremInvoiceSubscriberListResultListVBAResponse' text/json: schema: $ref: '#/components/schemas/GetPremInvoiceSubscriberListResultListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/premium-invoices/{invoiceKey}/subscriber-details': get: tags: - Premium Invoice Subscribers summary: List of Premium Invoice Details for Subscribers description: 'Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.' operationId: ListPremInvoiceSubscriberDetails parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_PremInvoiceSubscriberDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_PremInvoiceSubscriberDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_PremInvoiceSubscriberDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}/subscriber-detail-adjustments': get: tags: - Premium Invoice Subscribers summary: List of Premium Invoice Adjustment Details for Subscribers description: 'Retrieves detailed invoice adjustments for subscribers associated with a specific invoice key, including financial summaries, & premium adjustments.' operationId: ListPremInvoiceSubscriberDetailAdjustments parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_PremInvoiceSubscriberDetailAdjustmentListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_PremInvoiceSubscriberDetailAdjustmentListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_PremInvoiceSubscriberDetailAdjustmentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}/subscribers/{groupID}/{divisionID}/{subscriberID}/details': post: tags: - Premium Invoice Subscriber Details summary: Create PremInvoiceSubscriberDetail description: Creates a new PremInvoiceSubscriberDetail operationId: CreatePremInvoiceSubscriberDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetail' text/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetail' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Invoice Subscriber Details summary: List PremInvoiceSubscriberDetail description: Lists all PremInvoiceSubscriberDetail for the given invoiceKey and groupID and divisionID and subscriberID operationId: ListPremInvoiceSubscriberDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}/subscribers/{groupID}/{divisionID}/{subscriberID}/details/{premRateKey}': get: tags: - Premium Invoice Subscriber Details summary: Get PremInvoiceSubscriberDetail description: Gets PremInvoiceSubscriberDetail operationId: GetPremInvoiceSubscriberDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Invoice Subscriber Details summary: Update PremInvoiceSubscriberDetail description: Updates a specific PremInvoiceSubscriberDetail. operationId: UpdatePremInvoiceSubscriberDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetail' text/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetail' application/*+json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/PremInvoiceSubscriberDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Invoice Subscriber Details summary: Delete PremInvoiceSubscriberDetail description: Deletes an PremInvoiceSubscriberDetail operationId: DeletePremInvoiceSubscriberDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-invoices/{invoiceKey}/subscribers/{groupID}/{divisionID}/{subscriberID}/details-batch': put: tags: - Premium Invoice Subscriber Details summary: Create or Update Batch PremInvoiceSubscriberDetail description: 'Create or Update multiple PremInvoiceSubscriberDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremInvoiceSubscriberDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: invoiceKey in: path description: Invoice Key required: true schema: type: integer format: int32 - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceSubscriberDetail' text/json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceSubscriberDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremInvoiceSubscriberDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-past-due-triggers: post: tags: - Premium Past Due Triggers summary: Create PremPastDueTrigger description: Creates a new PremPastDueTrigger operationId: CreatePremPastDueTrigger parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPastDueTrigger' text/json: schema: $ref: '#/components/schemas/PremPastDueTrigger' application/*+json: schema: $ref: '#/components/schemas/PremPastDueTrigger' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPastDueTriggerVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Past Due Triggers summary: List PremPastDueTrigger description: Lists all PremPastDueTrigger operationId: ListPremPastDueTrigger parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPastDueTriggerListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-past-due-triggers/{premPastDueTriggerKey}': get: tags: - Premium Past Due Triggers summary: Get PremPastDueTrigger description: Gets PremPastDueTrigger operationId: GetPremPastDueTrigger parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPastDueTriggerKey in: path description: PremPastDueTrigger Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPastDueTriggerVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Past Due Triggers summary: Update PremPastDueTrigger description: Updates a specific PremPastDueTrigger. operationId: UpdatePremPastDueTrigger parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPastDueTriggerKey in: path description: PremPastDueTrigger Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPastDueTrigger' text/json: schema: $ref: '#/components/schemas/PremPastDueTrigger' application/*+json: schema: $ref: '#/components/schemas/PremPastDueTrigger' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPastDueTriggerVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Past Due Triggers summary: Delete PremPastDueTrigger description: Deletes an PremPastDueTrigger operationId: DeletePremPastDueTrigger parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPastDueTriggerKey in: path description: PremPastDueTrigger Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-past-due-triggers-batch: put: tags: - Premium Past Due Triggers summary: Create or Update Batch PremPastDueTrigger description: 'Create or Update multiple PremPastDueTrigger at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremPastDueTrigger parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremPastDueTrigger' text/json: schema: type: array items: $ref: '#/components/schemas/PremPastDueTrigger' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremPastDueTrigger' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-past-due-group-triggers: post: tags: - Premium Past Due Group Triggers summary: Create PremPastDueTriggerGroup description: Creates a new PremPastDueTriggerGroup operationId: CreatePremPastDueTriggerGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroup' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroup' application/*+json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPastDueTriggerGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Past Due Group Triggers summary: List PremPastDueTriggerGroup description: Lists all PremPastDueTriggerGroup operationId: ListPremPastDueTriggerGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPastDueTriggerGroupListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroupListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroupListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-past-due-group-triggers/{premPastDueTriggerGroupKey}': get: tags: - Premium Past Due Group Triggers summary: Get PremPastDueTriggerGroup description: Gets PremPastDueTriggerGroup operationId: GetPremPastDueTriggerGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPastDueTriggerGroupKey in: path description: PremPastDueTriggerGroup Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPastDueTriggerGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Past Due Group Triggers summary: Update PremPastDueTriggerGroup description: Updates a specific PremPastDueTriggerGroup. operationId: UpdatePremPastDueTriggerGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPastDueTriggerGroupKey in: path description: PremPastDueTriggerGroup Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroup' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroup' application/*+json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPastDueTriggerGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Past Due Group Triggers summary: Delete PremPastDueTriggerGroup description: Deletes an PremPastDueTriggerGroup operationId: DeletePremPastDueTriggerGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPastDueTriggerGroupKey in: path description: PremPastDueTriggerGroup Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-past-due-group-triggers-batch: put: tags: - Premium Past Due Group Triggers summary: Create or Update Batch PremPastDueTriggerGroup description: 'Create or Update multiple PremPastDueTriggerGroup at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremPastDueTriggerGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremPastDueTriggerGroup' text/json: schema: type: array items: $ref: '#/components/schemas/PremPastDueTriggerGroup' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremPastDueTriggerGroup' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-past-due-subscriber-triggers: post: tags: - Premium Past Due Subscriber Triggers summary: Create PremPastDueTriggerSubscriber description: Creates a new PremPastDueTriggerSubscriber operationId: CreatePremPastDueTriggerSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriber' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriber' application/*+json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriber' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Past Due Subscriber Triggers summary: List PremPastDueTriggerSubscriber description: Lists all PremPastDueTriggerSubscriber operationId: ListPremPastDueTriggerSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriberListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriberListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriberListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-past-due-subscriber-triggers/{premPastDueTriggerSubscriberKey}': get: tags: - Premium Past Due Subscriber Triggers summary: Get PremPastDueTriggerSubscriber description: Gets PremPastDueTriggerSubscriber operationId: GetPremPastDueTriggerSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPastDueTriggerSubscriberKey in: path description: PremPastDueTriggerSubscriber Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Past Due Subscriber Triggers summary: Update PremPastDueTriggerSubscriber description: Updates a specific PremPastDueTriggerSubscriber. operationId: UpdatePremPastDueTriggerSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPastDueTriggerSubscriberKey in: path description: PremPastDueTriggerSubscriber Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriber' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriber' application/*+json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriber' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPastDueTriggerSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Past Due Subscriber Triggers summary: Delete PremPastDueTriggerSubscriber description: Deletes an PremPastDueTriggerSubscriber operationId: DeletePremPastDueTriggerSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPastDueTriggerSubscriberKey in: path description: PremPastDueTriggerSubscriber Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-past-due-subscriber-triggers-batch: put: tags: - Premium Past Due Subscriber Triggers summary: Create or Update Batch PremPastDueTriggerSubscriber description: 'Create or Update multiple PremPastDueTriggerSubscriber at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremPastDueTriggerSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremPastDueTriggerSubscriber' text/json: schema: type: array items: $ref: '#/components/schemas/PremPastDueTriggerSubscriber' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremPastDueTriggerSubscriber' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-payments: post: tags: - Premium Payments summary: Create PremPayment description: Creates a new PremPayment operationId: CreatePremPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPayment' text/json: schema: $ref: '#/components/schemas/PremPayment' application/*+json: schema: $ref: '#/components/schemas/PremPayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Payments summary: List PremPayment description: Lists all PremPayment operationId: ListPremPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-payments/{premPaymentKey}': get: tags: - Premium Payments summary: Get PremPayment description: Gets PremPayment operationId: GetPremPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Payments summary: Update PremPayment description: Updates a specific PremPayment. operationId: UpdatePremPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPayment' text/json: schema: $ref: '#/components/schemas/PremPayment' application/*+json: schema: $ref: '#/components/schemas/PremPayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Payments summary: Delete PremPayment description: Deletes an PremPayment operationId: DeletePremPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-payments-batch: put: tags: - Premium Payments summary: Create or Update Batch PremPayment description: 'Create or Update multiple PremPayment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremPayment' text/json: schema: type: array items: $ref: '#/components/schemas/PremPayment' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremPayment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-payment-file-formats: post: tags: - Premium Payment File Formats summary: Create PremPaymentFileFormat description: Creates a new PremPaymentFileFormat operationId: CreatePremPaymentFileFormat parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPaymentFileFormat' text/json: schema: $ref: '#/components/schemas/PremPaymentFileFormat' application/*+json: schema: $ref: '#/components/schemas/PremPaymentFileFormat' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentFileFormatVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentFileFormatVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentFileFormatVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Payment File Formats summary: List PremPaymentFileFormat description: Lists all PremPaymentFileFormat operationId: ListPremPaymentFileFormat parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentFileFormatListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentFileFormatListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentFileFormatListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-payment-file-formats/{paymentFileFormatKey}': get: tags: - Premium Payment File Formats summary: Get PremPaymentFileFormat description: Gets PremPaymentFileFormat operationId: GetPremPaymentFileFormat parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: paymentFileFormatKey in: path description: Payment File Format Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentFileFormatVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentFileFormatVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentFileFormatVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Payment File Formats summary: Update PremPaymentFileFormat description: Updates a specific PremPaymentFileFormat. operationId: UpdatePremPaymentFileFormat parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: paymentFileFormatKey in: path description: Payment File Format Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPaymentFileFormat' text/json: schema: $ref: '#/components/schemas/PremPaymentFileFormat' application/*+json: schema: $ref: '#/components/schemas/PremPaymentFileFormat' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentFileFormatVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentFileFormatVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentFileFormatVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Payment File Formats summary: Delete PremPaymentFileFormat description: Deletes an PremPaymentFileFormat operationId: DeletePremPaymentFileFormat parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: paymentFileFormatKey in: path description: Payment File Format Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-payment-file-formats-batch: put: tags: - Premium Payment File Formats summary: Create or Update Batch PremPaymentFileFormat description: 'Create or Update multiple PremPaymentFileFormat at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremPaymentFileFormat parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremPaymentFileFormat' text/json: schema: type: array items: $ref: '#/components/schemas/PremPaymentFileFormat' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremPaymentFileFormat' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-payments/{premPaymentKey}/account-payments': post: tags: - Premium Payments On Accounts summary: Create PremPaymentOnAccount description: Creates a new PremPaymentOnAccount operationId: CreatePremPaymentOnAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPaymentOnAccount' text/json: schema: $ref: '#/components/schemas/PremPaymentOnAccount' application/*+json: schema: $ref: '#/components/schemas/PremPaymentOnAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentOnAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentOnAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentOnAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Payments On Accounts summary: List PremPaymentOnAccount description: Lists all PremPaymentOnAccount for the given premPaymentKey operationId: ListPremPaymentOnAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentOnAccountListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentOnAccountListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentOnAccountListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-payments/{premPaymentKey}/account-payments/{premPaymentOnAccountKey}': get: tags: - Premium Payments On Accounts summary: Get PremPaymentOnAccount description: Gets PremPaymentOnAccount operationId: GetPremPaymentOnAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 - name: premPaymentOnAccountKey in: path description: PremPaymentOnAccount Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentOnAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentOnAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentOnAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Payments On Accounts summary: Update PremPaymentOnAccount description: Updates a specific PremPaymentOnAccount. operationId: UpdatePremPaymentOnAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 - name: premPaymentOnAccountKey in: path description: PremPaymentOnAccount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPaymentOnAccount' text/json: schema: $ref: '#/components/schemas/PremPaymentOnAccount' application/*+json: schema: $ref: '#/components/schemas/PremPaymentOnAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentOnAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentOnAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentOnAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Payments On Accounts summary: Delete PremPaymentOnAccount description: Deletes an PremPaymentOnAccount operationId: DeletePremPaymentOnAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 - name: premPaymentOnAccountKey in: path description: PremPaymentOnAccount Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-payments/{premPaymentKey}/account-payments-batch': put: tags: - Premium Payments On Accounts summary: Create or Update Batch PremPaymentOnAccount description: 'Create or Update multiple PremPaymentOnAccount at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremPaymentOnAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremPaymentOnAccount' text/json: schema: type: array items: $ref: '#/components/schemas/PremPaymentOnAccount' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremPaymentOnAccount' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-payments/{premPaymentKey}/subscriber-payments': post: tags: - Premium Payments on Subscribers summary: Create PremPaymentSubscriber description: Creates a new PremPaymentSubscriber operationId: CreatePremPaymentSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPaymentSubscriber' text/json: schema: $ref: '#/components/schemas/PremPaymentSubscriber' application/*+json: schema: $ref: '#/components/schemas/PremPaymentSubscriber' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Payments on Subscribers summary: List PremPaymentSubscriber description: Lists all PremPaymentSubscriber for the given premPaymentKey operationId: ListPremPaymentSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentSubscriberListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentSubscriberListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentSubscriberListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-payments/{premPaymentKey}/subscriber-payments/{subscriberID}': get: tags: - Premium Payments on Subscribers summary: Get PremPaymentSubscriber description: Gets PremPaymentSubscriber operationId: GetPremPaymentSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Payments on Subscribers summary: Update PremPaymentSubscriber description: Updates a specific PremPaymentSubscriber. operationId: UpdatePremPaymentSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPaymentSubscriber' text/json: schema: $ref: '#/components/schemas/PremPaymentSubscriber' application/*+json: schema: $ref: '#/components/schemas/PremPaymentSubscriber' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentSubscriberVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentSubscriberVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentSubscriberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Payments on Subscribers summary: Delete PremPaymentSubscriber description: Deletes an PremPaymentSubscriber operationId: DeletePremPaymentSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-payments/{premPaymentKey}/subscriber-payments-batch': put: tags: - Premium Payments on Subscribers summary: Create or Update Batch PremPaymentSubscriber description: 'Create or Update multiple PremPaymentSubscriber at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremPaymentSubscriber parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premPaymentKey in: path description: PremPayment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremPaymentSubscriber' text/json: schema: type: array items: $ref: '#/components/schemas/PremPaymentSubscriber' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremPaymentSubscriber' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-payment-types: post: tags: - Premium Payment Types summary: Create PremPaymentType description: Creates a new PremPaymentType operationId: CreatePremPaymentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPaymentType' text/json: schema: $ref: '#/components/schemas/PremPaymentType' application/*+json: schema: $ref: '#/components/schemas/PremPaymentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Payment Types summary: List PremPaymentType description: Lists all PremPaymentType operationId: ListPremPaymentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-payment-types/{paymentType}': get: tags: - Premium Payment Types summary: Get PremPaymentType description: Gets PremPaymentType operationId: GetPremPaymentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: paymentType in: path description: Payment Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Payment Types summary: Update PremPaymentType description: Updates a specific PremPaymentType. operationId: UpdatePremPaymentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: paymentType in: path description: Payment Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremPaymentType' text/json: schema: $ref: '#/components/schemas/PremPaymentType' application/*+json: schema: $ref: '#/components/schemas/PremPaymentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremPaymentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremPaymentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremPaymentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Payment Types summary: Delete PremPaymentType description: Deletes an PremPaymentType operationId: DeletePremPaymentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: paymentType in: path description: Payment Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-payment-types-batch: put: tags: - Premium Payment Types summary: Create or Update Batch PremPaymentType description: 'Create or Update multiple PremPaymentType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremPaymentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremPaymentType' text/json: schema: type: array items: $ref: '#/components/schemas/PremPaymentType' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremPaymentType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rates: post: tags: - Premium Rates summary: Create PremRate description: Creates a new PremRate operationId: CreatePremRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRate' text/json: schema: $ref: '#/components/schemas/PremRate' application/*+json: schema: $ref: '#/components/schemas/PremRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Rates summary: List PremRate description: Lists all PremRate operationId: ListPremRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateType in: query description: PremRate_Type schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rates-nested: get: tags: - Premium Rates summary: List Premium Rates nested by Division/Plan/Category/Basis description: 'Lists all Premium Rates for the given groupID and have it nested by Division, then by Plan, then by Rate Category, then by Rate Basis.' operationId: ListPremRateNested parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateType in: query description: PremRate_Type schema: type: string - name: groupID in: query description: Group ID schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateNestedListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateNestedListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateNestedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}': get: tags: - Premium Rates summary: Get PremRate description: Gets PremRate operationId: GetPremRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Rates summary: Update PremRate description: Updates a specific PremRate. operationId: UpdatePremRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRate' text/json: schema: $ref: '#/components/schemas/PremRate' application/*+json: schema: $ref: '#/components/schemas/PremRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Rates summary: Delete PremRate description: Deletes an PremRate operationId: DeletePremRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rates-batch: put: tags: - Premium Rates summary: Create or Update Batch PremRate description: 'Create or Update multiple PremRate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRate' text/json: schema: type: array items: $ref: '#/components/schemas/PremRate' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /included-premium-rates: get: tags: - Premium Rates summary: List Included PremRate description: Lists all PremRate included in the specified Group ID and Division ID. operationId: ListIncludedPremRates parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupId in: query description: Group ID required: true schema: type: string - name: divisionId in: query description: Division ID schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}/add-from-template/{groupID}/{divisionID}/{premRateType}': post: tags: - Premium Rates - Adv. Billing summary: Add Rate from Template description: Create a new Premium Rate based on the selected Template Rate. operationId: AddPremRateFromTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: Subscriber ID required: true schema: type: integer format: int32 - name: groupID in: path description: Subscriber ID required: true schema: type: string - name: divisionID in: path description: Subscriber ID required: true schema: type: string - name: premRateType in: path description: Subscriber ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/premium-rates/{PremRate_Key}/add-ons': post: tags: - Premium Rate Add-Ons summary: Create PremRateAddOn description: Creates a new PremRateAddOn operationId: CreatePremRateAddOn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: PremRate_Key in: path description: PremRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateAddOn' text/json: schema: $ref: '#/components/schemas/PremRateAddOn' application/*+json: schema: $ref: '#/components/schemas/PremRateAddOn' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateAddOnVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateAddOnVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateAddOnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Rate Add-Ons summary: List PremRateAddOn description: Lists all PremRateAddOn for the given PremRate_Key operationId: ListPremRateAddOn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: PremRate_Key in: path description: PremRate Key required: true schema: type: integer format: int32 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateAddOnListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateAddOnListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateAddOnListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{PremRate_Key}/add-ons/{PremRateAddOn_Key}': get: tags: - Premium Rate Add-Ons summary: Get PremRateAddOn description: Gets PremRateAddOn operationId: GetPremRateAddOn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: PremRate_Key in: path description: PremRate Key required: true schema: type: integer format: int32 - name: PremRateAddOn_Key in: path description: PremRateAddOn Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateAddOnVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateAddOnVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateAddOnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Rate Add-Ons summary: Update PremRateAddOn description: Updates a specific PremRateAddOn. operationId: UpdatePremRateAddOn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: PremRate_Key in: path description: PremRate Key required: true schema: type: integer format: int32 - name: PremRateAddOn_Key in: path description: PremRateAddOn Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateAddOn' text/json: schema: $ref: '#/components/schemas/PremRateAddOn' application/*+json: schema: $ref: '#/components/schemas/PremRateAddOn' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateAddOnVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateAddOnVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateAddOnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Rate Add-Ons summary: Delete PremRateAddOn description: Deletes an PremRateAddOn operationId: DeletePremRateAddOn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: PremRate_Key in: path description: PremRate Key required: true schema: type: integer format: int32 - name: PremRateAddOn_Key in: path description: PremRateAddOn Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{PremRate_Key}/add-ons-batch': put: tags: - Premium Rate Add-Ons summary: Create or Update Batch PremRateAddOn description: 'Create or Update multiple PremRateAddOn at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRateAddOn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: PremRate_Key in: path description: PremRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRateAddOn' text/json: schema: type: array items: $ref: '#/components/schemas/PremRateAddOn' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRateAddOn' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rate-age-types: post: tags: - Premium Rate Age Types summary: Create PremRateAgeType description: Creates a new PremRateAgeType operationId: CreatePremRateAgeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateAgeType' text/json: schema: $ref: '#/components/schemas/PremRateAgeType' application/*+json: schema: $ref: '#/components/schemas/PremRateAgeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateAgeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateAgeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateAgeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Rate Age Types summary: List PremRateAgeType description: Lists all PremRateAgeType operationId: ListPremRateAgeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateAgeTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateAgeTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateAgeTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rate-age-types/{ageType}': get: tags: - Premium Rate Age Types summary: Get PremRateAgeType description: Gets PremRateAgeType operationId: GetPremRateAgeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ageType in: path description: Age Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateAgeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateAgeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateAgeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Rate Age Types summary: Update PremRateAgeType description: Updates a specific PremRateAgeType. operationId: UpdatePremRateAgeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ageType in: path description: Age Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateAgeType' text/json: schema: $ref: '#/components/schemas/PremRateAgeType' application/*+json: schema: $ref: '#/components/schemas/PremRateAgeType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateAgeTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateAgeTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateAgeTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Rate Age Types summary: Delete PremRateAgeType description: Deletes an PremRateAgeType operationId: DeletePremRateAgeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ageType in: path description: Age Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rate-age-types-batch: put: tags: - Premium Rate Age Types summary: Create or Update Batch PremRateAgeType description: 'Create or Update multiple PremRateAgeType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRateAgeType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRateAgeType' text/json: schema: type: array items: $ref: '#/components/schemas/PremRateAgeType' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRateAgeType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rate-bases: post: tags: - Premium Rate Basis summary: Create PremRateBasis description: Creates a new PremRateBasis operationId: CreatePremRateBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateBasis' text/json: schema: $ref: '#/components/schemas/PremRateBasis' application/*+json: schema: $ref: '#/components/schemas/PremRateBasis' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateBasisVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateBasisVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateBasisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Rate Basis summary: List PremRateBasis description: Lists all PremRateBasis operationId: ListPremRateBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateBasisListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateBasisListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateBasisListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rate-bases/{premRateBasis}': get: tags: - Premium Rate Basis summary: Get PremRateBasis description: Gets PremRateBasis operationId: GetPremRateBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateBasis in: path description: PremRate Basis required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateBasisVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateBasisVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateBasisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Rate Basis summary: Update PremRateBasis description: Updates a specific PremRateBasis. operationId: UpdatePremRateBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateBasis in: path description: PremRate Basis required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateBasis' text/json: schema: $ref: '#/components/schemas/PremRateBasis' application/*+json: schema: $ref: '#/components/schemas/PremRateBasis' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateBasisVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateBasisVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateBasisVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Rate Basis summary: Delete PremRateBasis description: Deletes an PremRateBasis operationId: DeletePremRateBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateBasis in: path description: PremRate Basis required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rate-bases-batch: put: tags: - Premium Rate Basis summary: Create or Update Batch PremRateBasis description: 'Create or Update multiple PremRateBasis at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRateBasis parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRateBasis' text/json: schema: type: array items: $ref: '#/components/schemas/PremRateBasis' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRateBasis' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rate-categories: post: tags: - Premium Rate Categories summary: Create PremRateCategory description: Creates a new PremRateCategory operationId: CreatePremRateCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateCategory' text/json: schema: $ref: '#/components/schemas/PremRateCategory' application/*+json: schema: $ref: '#/components/schemas/PremRateCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Rate Categories summary: List PremRateCategory description: Lists all PremRateCategory operationId: ListPremRateCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rate-categories/{premRateCategory}': get: tags: - Premium Rate Categories summary: Get PremRateCategory description: Gets PremRateCategory operationId: GetPremRateCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateCategory in: path description: PremRate Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Rate Categories summary: Update PremRateCategory description: Updates a specific PremRateCategory. operationId: UpdatePremRateCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateCategory in: path description: PremRate Category required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateCategory' text/json: schema: $ref: '#/components/schemas/PremRateCategory' application/*+json: schema: $ref: '#/components/schemas/PremRateCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Rate Categories summary: Delete PremRateCategory description: Deletes an PremRateCategory operationId: DeletePremRateCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateCategory in: path description: PremRate Category required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rate-categories-batch: put: tags: - Premium Rate Categories summary: Create or Update Batch PremRateCategory description: 'Create or Update multiple PremRateCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRateCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRateCategory' text/json: schema: type: array items: $ref: '#/components/schemas/PremRateCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRateCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}/excludes': post: tags: - Premium Rate Excludes summary: Create PremRateExclude description: Creates a new PremRateExclude operationId: CreatePremRateExclude parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateExclude' text/json: schema: $ref: '#/components/schemas/PremRateExclude' application/*+json: schema: $ref: '#/components/schemas/PremRateExclude' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateExcludeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateExcludeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateExcludeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Rate Excludes summary: List PremRateExclude description: Lists all PremRateExclude for the given premRateKey operationId: ListPremRateExclude parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateExcludeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateExcludeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateExcludeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}/excludes/{premRateExcludeKey}': get: tags: - Premium Rate Excludes summary: Get PremRateExclude description: Gets PremRateExclude operationId: GetPremRateExclude parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: premRateExcludeKey in: path description: PremRateExclude Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateExcludeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateExcludeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateExcludeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Rate Excludes summary: Update PremRateExclude description: Updates a specific PremRateExclude. operationId: UpdatePremRateExclude parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: premRateExcludeKey in: path description: PremRateExclude Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateExclude' text/json: schema: $ref: '#/components/schemas/PremRateExclude' application/*+json: schema: $ref: '#/components/schemas/PremRateExclude' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateExcludeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateExcludeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateExcludeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Rate Excludes summary: Delete PremRateExclude description: Deletes an PremRateExclude operationId: DeletePremRateExclude parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: premRateExcludeKey in: path description: PremRateExclude Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}/excludes-batch': put: tags: - Premium Rate Excludes summary: Create or Update Batch PremRateExclude description: 'Create or Update multiple PremRateExclude at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRateExclude parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRateExclude' text/json: schema: type: array items: $ref: '#/components/schemas/PremRateExclude' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRateExclude' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}/members': post: tags: - Premium Rate Members summary: Create PremRateMember description: Creates a new PremRateMember operationId: CreatePremRateMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateMember' text/json: schema: $ref: '#/components/schemas/PremRateMember' application/*+json: schema: $ref: '#/components/schemas/PremRateMember' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateMemberVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateMemberVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateMemberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Rate Members summary: List PremRateMember description: Lists all PremRateMember for the given premRateKey operationId: ListPremRateMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateMemberListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateMemberListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateMemberListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}/members/{subscriberID}/{memberSeq}/{effectiveDate}': get: tags: - Premium Rate Members summary: Get PremRateMember description: Gets PremRateMember operationId: GetPremRateMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateMemberVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateMemberVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateMemberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Rate Members summary: Update PremRateMember description: Updates a specific PremRateMember. operationId: UpdatePremRateMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateMember' text/json: schema: $ref: '#/components/schemas/PremRateMember' application/*+json: schema: $ref: '#/components/schemas/PremRateMember' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateMemberVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateMemberVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateMemberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Rate Members summary: Delete PremRateMember description: Deletes an PremRateMember operationId: DeletePremRateMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}/members-batch': put: tags: - Premium Rate Members summary: Create or Update Batch PremRateMember description: 'Create or Update multiple PremRateMember at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRateMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRateMember' text/json: schema: type: array items: $ref: '#/components/schemas/PremRateMember' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRateMember' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rate-min-max: post: tags: - Premium Rate Min/Max summary: Create PremRateMinMax description: Creates a new PremRateMinMax operationId: CreatePremRateMinMax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateMinMax' text/json: schema: $ref: '#/components/schemas/PremRateMinMax' application/*+json: schema: $ref: '#/components/schemas/PremRateMinMax' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateMinMaxVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateMinMaxVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateMinMaxVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Rate Min/Max summary: List PremRateMinMax description: Lists all PremRateMinMax operationId: ListPremRateMinMax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateMinMaxListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateMinMaxListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateMinMaxListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rate-min-max/{premRateMinMaxKey}': get: tags: - Premium Rate Min/Max summary: Get PremRateMinMax description: Gets PremRateMinMax operationId: GetPremRateMinMax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateMinMaxKey in: path description: PremRateMinMax Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateMinMaxVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateMinMaxVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateMinMaxVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Rate Min/Max summary: Update PremRateMinMax description: Updates a specific PremRateMinMax. operationId: UpdatePremRateMinMax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateMinMaxKey in: path description: PremRateMinMax Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateMinMax' text/json: schema: $ref: '#/components/schemas/PremRateMinMax' application/*+json: schema: $ref: '#/components/schemas/PremRateMinMax' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateMinMaxVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateMinMaxVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateMinMaxVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Rate Min/Max summary: Delete PremRateMinMax description: Deletes an PremRateMinMax operationId: DeletePremRateMinMax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateMinMaxKey in: path description: PremRateMinMax Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rate-min-max-batch: put: tags: - Premium Rate Min/Max summary: Create or Update Batch PremRateMinMax description: 'Create or Update multiple PremRateMinMax at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRateMinMax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRateMinMax' text/json: schema: type: array items: $ref: '#/components/schemas/PremRateMinMax' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRateMinMax' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateMinMaxKey}/premium-rate-min-max-details': post: tags: - Premium Rate Min/Max Details summary: Create PremRateMinMaxDetail description: Creates a new PremRateMinMaxDetail operationId: CreatePremRateMinMaxDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateMinMaxKey in: path description: PremRate Min Max Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateMinMaxDetail' text/json: schema: $ref: '#/components/schemas/PremRateMinMaxDetail' application/*+json: schema: $ref: '#/components/schemas/PremRateMinMaxDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateMinMaxDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateMinMaxDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateMinMaxDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Rate Min/Max Details summary: List PremRateMinMaxDetail description: Lists all PremRateMinMaxDetail for the given premRateMinMaxKey operationId: ListPremRateMinMaxDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateMinMaxKey in: path description: PremRate Min Max Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateMinMaxDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateMinMaxDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateMinMaxDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateMinMaxKey}/premium-rate-min-max-details/{premRateKey}': get: tags: - Premium Rate Min/Max Details summary: Get PremRateMinMaxDetail description: Gets PremRateMinMaxDetail operationId: GetPremRateMinMaxDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: premRateMinMaxKey in: path description: PremRateMinMax Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateMinMaxDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateMinMaxDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateMinMaxDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Rate Min/Max Details summary: Update PremRateMinMaxDetail description: Updates a specific PremRateMinMaxDetail. operationId: UpdatePremRateMinMaxDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: premRateMinMaxKey in: path description: PremRateMinMax Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateMinMaxDetail' text/json: schema: $ref: '#/components/schemas/PremRateMinMaxDetail' application/*+json: schema: $ref: '#/components/schemas/PremRateMinMaxDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateMinMaxDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateMinMaxDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateMinMaxDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Rate Min/Max Details summary: Delete PremRateMinMaxDetail description: Deletes an PremRateMinMaxDetail operationId: DeletePremRateMinMaxDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: premRateMinMaxKey in: path description: PremRateMinMax Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateMinMaxKey}/premium-rate-min-max-details-batch': put: tags: - Premium Rate Min/Max Details summary: Create or Update Batch PremRateMinMaxDetail description: 'Create or Update multiple PremRateMinMaxDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRateMinMaxDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateMinMaxKey in: path description: PremRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRateMinMaxDetail' text/json: schema: type: array items: $ref: '#/components/schemas/PremRateMinMaxDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRateMinMaxDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rate-paces: post: tags: - Premium Rate Paces summary: Create PremRatePace description: Creates a new PremRatePace operationId: CreatePremRatePace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRatePace' text/json: schema: $ref: '#/components/schemas/PremRatePace' application/*+json: schema: $ref: '#/components/schemas/PremRatePace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRatePaceVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRatePaceVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRatePaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Rate Paces summary: List PremRatePace description: Lists all PremRatePace operationId: ListPremRatePace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRatePaceListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRatePaceListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRatePaceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rate-paces/{ratePace}': get: tags: - Premium Rate Paces summary: Get PremRatePace description: Gets PremRatePace operationId: GetPremRatePace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ratePace in: path description: Rate Pace required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRatePaceVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRatePaceVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRatePaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Rate Paces summary: Update PremRatePace description: Updates a specific PremRatePace. operationId: UpdatePremRatePace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ratePace in: path description: Rate Pace required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRatePace' text/json: schema: $ref: '#/components/schemas/PremRatePace' application/*+json: schema: $ref: '#/components/schemas/PremRatePace' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRatePaceVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRatePaceVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRatePaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Rate Paces summary: Delete PremRatePace description: Deletes an PremRatePace operationId: DeletePremRatePace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ratePace in: path description: Rate Pace required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rate-paces-batch: put: tags: - Premium Rate Paces summary: Create or Update Batch PremRatePace description: 'Create or Update multiple PremRatePace at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRatePace parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRatePace' text/json: schema: type: array items: $ref: '#/components/schemas/PremRatePace' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRatePace' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rate-pace-types: post: tags: - Premium Rate Pace Types summary: Create PremRatePaceType description: Creates a new PremRatePaceType operationId: CreatePremRatePaceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRatePaceType' text/json: schema: $ref: '#/components/schemas/PremRatePaceType' application/*+json: schema: $ref: '#/components/schemas/PremRatePaceType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRatePaceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRatePaceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRatePaceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Rate Pace Types summary: List PremRatePaceType description: Lists all PremRatePaceType operationId: ListPremRatePaceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRatePaceTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRatePaceTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRatePaceTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rate-pace-types/{ratePaceType}': get: tags: - Premium Rate Pace Types summary: Get PremRatePaceType description: Gets PremRatePaceType operationId: GetPremRatePaceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ratePaceType in: path description: Rate Pace Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRatePaceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRatePaceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRatePaceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Rate Pace Types summary: Update PremRatePaceType description: Updates a specific PremRatePaceType. operationId: UpdatePremRatePaceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ratePaceType in: path description: Rate Pace Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRatePaceType' text/json: schema: $ref: '#/components/schemas/PremRatePaceType' application/*+json: schema: $ref: '#/components/schemas/PremRatePaceType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRatePaceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRatePaceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRatePaceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Rate Pace Types summary: Delete PremRatePaceType description: Deletes an PremRatePaceType operationId: DeletePremRatePaceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: ratePaceType in: path description: Rate Pace Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rate-pace-types-batch: put: tags: - Premium Rate Pace Types summary: Create or Update Batch PremRatePaceType description: 'Create or Update multiple PremRatePaceType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRatePaceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRatePaceType' text/json: schema: type: array items: $ref: '#/components/schemas/PremRatePaceType' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRatePaceType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}/payees': post: tags: - Premium Rate Payees summary: Create PremRatePayee description: Creates a new PremRatePayee operationId: CreatePremRatePayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRatePayee' text/json: schema: $ref: '#/components/schemas/PremRatePayee' application/*+json: schema: $ref: '#/components/schemas/PremRatePayee' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRatePayeeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRatePayeeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRatePayeeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Rate Payees summary: List PremRatePayee description: Lists all PremRatePayee for the given premRateKey operationId: ListPremRatePayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRatePayeeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRatePayeeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRatePayeeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}/payees/{payeeID}': get: tags: - Premium Rate Payees summary: Get PremRatePayee description: Gets PremRatePayee operationId: GetPremRatePayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: payeeID in: path description: Payee ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRatePayeeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRatePayeeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRatePayeeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Rate Payees summary: Update PremRatePayee description: Updates a specific PremRatePayee. operationId: UpdatePremRatePayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: payeeID in: path description: Payee ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRatePayee' text/json: schema: $ref: '#/components/schemas/PremRatePayee' application/*+json: schema: $ref: '#/components/schemas/PremRatePayee' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRatePayeeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRatePayeeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRatePayeeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Rate Payees summary: Delete PremRatePayee description: Deletes an PremRatePayee operationId: DeletePremRatePayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: payeeID in: path description: Payee ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}/payees-batch': put: tags: - Premium Rate Payees summary: Create or Update Batch PremRatePayee description: 'Create or Update multiple PremRatePayee at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRatePayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRatePayee' text/json: schema: type: array items: $ref: '#/components/schemas/PremRatePayee' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRatePayee' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /prem-rate-types: post: tags: - Prem Rate Types summary: Create PremRateType description: Creates a new PremRateType operationId: CreatePremRateType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateType' text/json: schema: $ref: '#/components/schemas/PremRateType' application/*+json: schema: $ref: '#/components/schemas/PremRateType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Prem Rate Types summary: List PremRateType description: Lists all PremRateType operationId: ListPremRateType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/prem-rate-types/{rateType}': get: tags: - Prem Rate Types summary: Get PremRateType description: Gets PremRateType operationId: GetPremRateType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: rateType in: path description: Rate Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Prem Rate Types summary: Update PremRateType description: Updates a specific PremRateType. operationId: UpdatePremRateType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: rateType in: path description: Rate Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateType' text/json: schema: $ref: '#/components/schemas/PremRateType' application/*+json: schema: $ref: '#/components/schemas/PremRateType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Prem Rate Types summary: Delete PremRateType description: Deletes an PremRateType operationId: DeletePremRateType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: rateType in: path description: Rate Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /prem-rate-types-batch: put: tags: - Prem Rate Types summary: Create or Update Batch PremRateType description: 'Create or Update multiple PremRateType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRateType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRateType' text/json: schema: type: array items: $ref: '#/components/schemas/PremRateType' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRateType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}/zipcodes': post: tags: - Premium Rate Zipcodes summary: Create PremRateZip description: Creates a new PremRateZip operationId: CreatePremRateZip parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateZip' text/json: schema: $ref: '#/components/schemas/PremRateZip' application/*+json: schema: $ref: '#/components/schemas/PremRateZip' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateZipVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateZipVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateZipVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Premium Rate Zipcodes summary: List PremRateZip description: Lists all PremRateZip for the given premRateKey operationId: ListPremRateZip parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateZipListVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateZipListVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateZipListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}/zipcodes/{premRateZipKey}': get: tags: - Premium Rate Zipcodes summary: Get PremRateZip description: Gets PremRateZip operationId: GetPremRateZip parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: premRateZipKey in: path description: PremRateZip Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateZipVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateZipVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateZipVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Premium Rate Zipcodes summary: Update PremRateZip description: Updates a specific PremRateZip. operationId: UpdatePremRateZip parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: premRateZipKey in: path description: PremRateZip Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PremRateZip' text/json: schema: $ref: '#/components/schemas/PremRateZip' application/*+json: schema: $ref: '#/components/schemas/PremRateZip' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PremRateZipVBAResponse' application/json: schema: $ref: '#/components/schemas/PremRateZipVBAResponse' text/json: schema: $ref: '#/components/schemas/PremRateZipVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Premium Rate Zipcodes summary: Delete PremRateZip description: Deletes an PremRateZip operationId: DeletePremRateZip parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 - name: premRateZipKey in: path description: PremRateZip Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/premium-rates/{premRateKey}/zipcodes-batch': put: tags: - Premium Rate Zipcodes summary: Create or Update Batch PremRateZip description: 'Create or Update multiple PremRateZip at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchPremRateZip parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: premRateKey in: path description: PremRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PremRateZip' text/json: schema: type: array items: $ref: '#/components/schemas/PremRateZip' application/*+json: schema: type: array items: $ref: '#/components/schemas/PremRateZip' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /procedure-categories: post: tags: - Procedure Categories summary: Create ProcedureCategory description: Creates a new ProcedureCategory operationId: CreateProcedureCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureCategory' text/json: schema: $ref: '#/components/schemas/ProcedureCategory' application/*+json: schema: $ref: '#/components/schemas/ProcedureCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Procedure Categories summary: List ProcedureCategory description: 'Lists all ProcedureCategory given a specific ' operationId: ListProcedureCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/procedure-categories/{categoryID}': get: tags: - Procedure Categories summary: Get ProcedureCategory description: Gets ProcedureCategory operationId: GetProcedureCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: categoryID in: path description: Category ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Procedure Categories summary: Update ProcedureCategory description: Updates a specific ProcedureCategory. operationId: UpdateProcedureCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: categoryID in: path description: Category ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureCategory' text/json: schema: $ref: '#/components/schemas/ProcedureCategory' application/*+json: schema: $ref: '#/components/schemas/ProcedureCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Procedure Categories summary: Delete ProcedureCategory description: Deletes an ProcedureCategory operationId: DeleteProcedureCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: categoryID in: path description: Category ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /procedure-categories-batch: put: tags: - Procedure Categories summary: Create or Update Batch ProcedureCategory description: 'Create or Update multiple ProcedureCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProcedureCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProcedureCategory' text/json: schema: type: array items: $ref: '#/components/schemas/ProcedureCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProcedureCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /procedure-clusters: post: tags: - Procedure Clusters summary: Create ProcedureCluster description: Creates a new ProcedureCluster operationId: CreateProcedureCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureCluster' text/json: schema: $ref: '#/components/schemas/ProcedureCluster' application/*+json: schema: $ref: '#/components/schemas/ProcedureCluster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Procedure Clusters summary: List ProcedureCluster description: Lists all ProcedureCluster operationId: ListProcedureCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureClusterListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureClusterListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureClusterListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/procedure-clusters/{procedureCluster}': get: tags: - Procedure Clusters summary: Get ProcedureCluster description: Gets ProcedureCluster operationId: GetProcedureCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCluster in: path description: Procedure Cluster required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Procedure Clusters summary: Update ProcedureCluster description: Updates a specific ProcedureCluster. operationId: UpdateProcedureCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCluster in: path description: Procedure Cluster required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureCluster' text/json: schema: $ref: '#/components/schemas/ProcedureCluster' application/*+json: schema: $ref: '#/components/schemas/ProcedureCluster' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureClusterVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureClusterVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureClusterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Procedure Clusters summary: Delete ProcedureCluster description: Deletes an ProcedureCluster operationId: DeleteProcedureCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCluster in: path description: Procedure Cluster required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /procedure-clusters-batch: put: tags: - Procedure Clusters summary: Create or Update Batch ProcedureCluster description: 'Create or Update multiple ProcedureCluster at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProcedureCluster parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProcedureCluster' text/json: schema: type: array items: $ref: '#/components/schemas/ProcedureCluster' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProcedureCluster' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/procedure-clusters/{procedureCluster}/details': post: tags: - Procedure Cluster Details summary: Create ProcedureClusterDetail description: Creates a new ProcedureClusterDetail operationId: CreateProcedureClusterDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCluster in: path description: Procedure Cluster required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureClusterDetail' text/json: schema: $ref: '#/components/schemas/ProcedureClusterDetail' application/*+json: schema: $ref: '#/components/schemas/ProcedureClusterDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureClusterDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureClusterDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureClusterDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Procedure Cluster Details summary: List ProcedureClusterDetail description: Lists all ProcedureClusterDetail for the given procedureCluster operationId: ListProcedureClusterDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCluster in: path description: Procedure Cluster required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureClusterDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureClusterDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureClusterDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/procedure-clusters/{procedureCluster}/details/{procedureClusterDetailKey}': get: tags: - Procedure Cluster Details summary: Get ProcedureClusterDetail description: Gets ProcedureClusterDetail operationId: GetProcedureClusterDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCluster in: path description: Procedure Cluster required: true schema: type: string - name: procedureClusterDetailKey in: path description: ProcedureClusterDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureClusterDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureClusterDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureClusterDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Procedure Cluster Details summary: Update ProcedureClusterDetail description: Updates a specific ProcedureClusterDetail. operationId: UpdateProcedureClusterDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCluster in: path description: Procedure Cluster required: true schema: type: string - name: procedureClusterDetailKey in: path description: ProcedureClusterDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureClusterDetail' text/json: schema: $ref: '#/components/schemas/ProcedureClusterDetail' application/*+json: schema: $ref: '#/components/schemas/ProcedureClusterDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureClusterDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureClusterDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureClusterDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Procedure Cluster Details summary: Delete ProcedureClusterDetail description: Deletes an ProcedureClusterDetail operationId: DeleteProcedureClusterDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCluster in: path description: Procedure Cluster required: true schema: type: string - name: procedureClusterDetailKey in: path description: ProcedureClusterDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/procedure-clusters/{procedureCluster}/details-batch': put: tags: - Procedure Cluster Details summary: Create or Update Batch ProcedureClusterDetail description: 'Create or Update multiple ProcedureClusterDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProcedureClusterDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCluster in: path description: Procedure Cluster required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProcedureClusterDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ProcedureClusterDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProcedureClusterDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /procedure-codes: post: tags: - Procedure Codes summary: Create ProcedureCode description: Creates a new ProcedureCode operationId: CreateProcedureCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureCode' text/json: schema: $ref: '#/components/schemas/ProcedureCode' application/*+json: schema: $ref: '#/components/schemas/ProcedureCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Procedure Codes summary: List ProcedureCode description: Lists all ProcedureCode operationId: ListProcedureCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/procedure-codes/{procedureCode}': get: tags: - Procedure Codes summary: Get ProcedureCode description: Gets ProcedureCode operationId: GetProcedureCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Procedure Codes summary: Update ProcedureCode description: Updates a specific ProcedureCode. operationId: UpdateProcedureCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureCode' text/json: schema: $ref: '#/components/schemas/ProcedureCode' application/*+json: schema: $ref: '#/components/schemas/ProcedureCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Procedure Codes summary: Delete ProcedureCode description: Deletes an ProcedureCode operationId: DeleteProcedureCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /procedure-codes-batch: put: tags: - Procedure Codes summary: Create or Update Batch ProcedureCode description: 'Create or Update multiple ProcedureCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProcedureCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProcedureCode' text/json: schema: type: array items: $ref: '#/components/schemas/ProcedureCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProcedureCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /procedure-code-qualifiers: post: tags: - Procedure Code Qualifiers summary: Create ProcedureCodeQualifier description: Creates a new ProcedureCodeQualifier operationId: CreateProcedureCodeQualifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureCodeQualifier' text/json: schema: $ref: '#/components/schemas/ProcedureCodeQualifier' application/*+json: schema: $ref: '#/components/schemas/ProcedureCodeQualifier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCodeQualifierVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCodeQualifierVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCodeQualifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Procedure Code Qualifiers summary: List ProcedureCodeQualifier description: Lists all ProcedureCodeQualifier operationId: ListProcedureCodeQualifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCodeQualifierListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCodeQualifierListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCodeQualifierListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/procedure-code-qualifiers/{qualifier}': get: tags: - Procedure Code Qualifiers summary: Get ProcedureCodeQualifier description: Gets ProcedureCodeQualifier operationId: GetProcedureCodeQualifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: qualifier in: path description: Qualifier required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCodeQualifierVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCodeQualifierVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCodeQualifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Procedure Code Qualifiers summary: Update ProcedureCodeQualifier description: Updates a specific ProcedureCodeQualifier. operationId: UpdateProcedureCodeQualifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: qualifier in: path description: Qualifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureCodeQualifier' text/json: schema: $ref: '#/components/schemas/ProcedureCodeQualifier' application/*+json: schema: $ref: '#/components/schemas/ProcedureCodeQualifier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCodeQualifierVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCodeQualifierVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCodeQualifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Procedure Code Qualifiers summary: Delete ProcedureCodeQualifier description: Deletes an ProcedureCodeQualifier operationId: DeleteProcedureCodeQualifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: qualifier in: path description: Qualifier required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /procedure-code-qualifiers-batch: put: tags: - Procedure Code Qualifiers summary: Create or Update Batch ProcedureCodeQualifier description: 'Create or Update multiple ProcedureCodeQualifier at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProcedureCodeQualifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProcedureCodeQualifier' text/json: schema: type: array items: $ref: '#/components/schemas/ProcedureCodeQualifier' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProcedureCodeQualifier' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/procedure-codes/{procedureCode}/sets': post: tags: - Procedure Code Sets summary: Create ProcedureCodeSet description: Creates a new ProcedureCodeSet operationId: CreateProcedureCodeSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureCodeSet' text/json: schema: $ref: '#/components/schemas/ProcedureCodeSet' application/*+json: schema: $ref: '#/components/schemas/ProcedureCodeSet' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCodeSetVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCodeSetVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCodeSetVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Procedure Code Sets summary: List ProcedureCodeSet description: Lists all ProcedureCodeSet for the given procedureCode operationId: ListProcedureCodeSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCodeSetListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCodeSetListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCodeSetListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/procedure-codes/{procedureCode}/sets/{codeSet}': get: tags: - Procedure Code Sets summary: Get ProcedureCodeSet description: Gets ProcedureCodeSet operationId: GetProcedureCodeSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string - name: codeSet in: path description: Code Set required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCodeSetVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCodeSetVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCodeSetVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Procedure Code Sets summary: Update ProcedureCodeSet description: Updates a specific ProcedureCodeSet. operationId: UpdateProcedureCodeSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string - name: codeSet in: path description: Code Set required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureCodeSet' text/json: schema: $ref: '#/components/schemas/ProcedureCodeSet' application/*+json: schema: $ref: '#/components/schemas/ProcedureCodeSet' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureCodeSetVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureCodeSetVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureCodeSetVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Procedure Code Sets summary: Delete ProcedureCodeSet description: Deletes an ProcedureCodeSet operationId: DeleteProcedureCodeSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string - name: codeSet in: path description: Code Set required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/procedure-codes/{procedureCode}/sets-batch': put: tags: - Procedure Code Sets summary: Create or Update Batch ProcedureCodeSet description: 'Create or Update multiple ProcedureCodeSet at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProcedureCodeSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProcedureCodeSet' text/json: schema: type: array items: $ref: '#/components/schemas/ProcedureCodeSet' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProcedureCodeSet' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /procedure-groups: post: tags: - Procedure Groups summary: Create ProcedureGroup description: Creates a new ProcedureGroup operationId: CreateProcedureGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureGroup' text/json: schema: $ref: '#/components/schemas/ProcedureGroup' application/*+json: schema: $ref: '#/components/schemas/ProcedureGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Procedure Groups summary: List ProcedureGroup description: Lists all ProcedureGroup operationId: ListProcedureGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureGroupListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureGroupListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureGroupListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/procedure-groups/{procedureGroup}': get: tags: - Procedure Groups summary: Get ProcedureGroup description: Gets ProcedureGroup operationId: GetProcedureGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureGroup in: path description: Procedure Group required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Procedure Groups summary: Update ProcedureGroup description: Updates a specific ProcedureGroup. operationId: UpdateProcedureGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureGroup in: path description: Procedure Group required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcedureGroup' text/json: schema: $ref: '#/components/schemas/ProcedureGroup' application/*+json: schema: $ref: '#/components/schemas/ProcedureGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProcedureGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/ProcedureGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/ProcedureGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Procedure Groups summary: Delete ProcedureGroup description: Deletes an ProcedureGroup operationId: DeleteProcedureGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: procedureGroup in: path description: Procedure Group required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /procedure-groups-batch: put: tags: - Procedure Groups summary: Create or Update Batch ProcedureGroup description: 'Create or Update multiple ProcedureGroup at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProcedureGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProcedureGroup' text/json: schema: type: array items: $ref: '#/components/schemas/ProcedureGroup' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProcedureGroup' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /providers: post: tags: - Provider summary: Create Provider description: Creates a new Provider operationId: CreateProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Provider' text/json: schema: $ref: '#/components/schemas/Provider' application/*+json: schema: $ref: '#/components/schemas/Provider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider summary: List Provider description: Lists all Provider operationId: ListProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}': get: tags: - Provider summary: Get Provider description: Gets Provider operationId: GetProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider summary: Update Provider description: Updates a specific Provider. operationId: UpdateProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Provider' text/json: schema: $ref: '#/components/schemas/Provider' application/*+json: schema: $ref: '#/components/schemas/Provider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider summary: Delete Provider description: Deletes an Provider operationId: DeleteProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /providers-batch: put: tags: - Provider summary: Create or Update Batch Provider description: 'Create or Update multiple Provider at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Provider' text/json: schema: type: array items: $ref: '#/components/schemas/Provider' application/*+json: schema: type: array items: $ref: '#/components/schemas/Provider' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/accounts': post: tags: - Provider Account summary: Create Provider Account description: Creates a new Provider Account operationId: CreateProviderAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAccount' text/json: schema: $ref: '#/components/schemas/ProviderAccount' application/*+json: schema: $ref: '#/components/schemas/ProviderAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Account summary: List Provider Accounts description: List Provider Accounts for a specific Provider ID. operationId: ListProviderAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAccountListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAccountListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAccountListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/accounts/{providerAccountKey}': get: tags: - Provider Account summary: Get Provider Account description: Gets Provider Account operationId: GetProviderAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerAccountKey in: path description: ProviderAccount Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Account summary: Update Provider Account description: Updates a specific Provider Account. operationId: UpdateProviderAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerAccountKey in: path description: ProviderAccount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAccount' text/json: schema: $ref: '#/components/schemas/ProviderAccount' application/*+json: schema: $ref: '#/components/schemas/ProviderAccount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAccountVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAccountVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAccountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Account summary: Delete Provider Account description: Deletes a Provider Account operationId: DeleteProviderAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerAccountKey in: path description: ProviderAccount Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/accounts-batch': put: tags: - Provider Account summary: Create or Update Batch Provider Account description: 'Create or Update multiple Provider Accounts at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderAccount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderAccount' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderAccount' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderAccount' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/affiliations': post: tags: - Provider Affiliation summary: Create ProviderAffiliation description: Creates a new ProviderAffiliation operationId: CreateProviderAffiliation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAffiliation' text/json: schema: $ref: '#/components/schemas/ProviderAffiliation' application/*+json: schema: $ref: '#/components/schemas/ProviderAffiliation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAffiliationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAffiliationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAffiliationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Affiliation summary: List ProviderAffiliation description: Gets all ProviderAffiliations for a specific Provider operationId: ListProviderAffiliation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAffiliationListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAffiliationListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAffiliationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/affiliations/{affiliationProviderID}/effective-dates/{effectiveDate}': get: tags: - Provider Affiliation summary: Get ProviderAffiliation description: Gets ProviderAffiliation operationId: GetProviderAffiliation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: affiliationProviderID in: path description: Affiliation Provider ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAffiliationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAffiliationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAffiliationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Affiliation summary: Update ProviderAffiliation description: Updates a specific ProviderAffiliation. operationId: UpdateProviderAffiliation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: affiliationProviderID in: path description: Affiliation Provider ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAffiliation' text/json: schema: $ref: '#/components/schemas/ProviderAffiliation' application/*+json: schema: $ref: '#/components/schemas/ProviderAffiliation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAffiliationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAffiliationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAffiliationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Affiliation summary: Delete ProviderAffiliation description: Deletes an ProviderAffiliation operationId: DeleteProviderAffiliation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: affiliationProviderID in: path description: Affiliation Provider ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/affiliations-batch': put: tags: - Provider Affiliation summary: Create or Update Batch ProviderAffiliation description: 'Create or Update multiple ProviderAffiliation at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderAffiliation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderAffiliation' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderAffiliation' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderAffiliation' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/alternates': post: tags: - Provider Alternate summary: Create ProviderAlternate description: Creates a new ProviderAlternate operationId: CreateProviderAlternate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAlternate' text/json: schema: $ref: '#/components/schemas/ProviderAlternate' application/*+json: schema: $ref: '#/components/schemas/ProviderAlternate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAlternateVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAlternateVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAlternateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Alternate summary: List ProviderAlternate description: Lists all ProviderAlternate given a specific providerID operationId: ListProviderAlternates parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAlternateListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAlternateListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAlternateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/alternates/{alternateProviderID}/effectiveDate/{effectiveDate}': get: tags: - Provider Alternate summary: Get ProviderAlternate description: Gets ProviderAlternate operationId: GetProviderAlternate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: alternateProviderID in: path description: Alternate Provider ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAlternateVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAlternateVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAlternateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Alternate summary: Update ProviderAlternate description: Updates a specific ProviderAlternate. operationId: UpdateProviderAlternate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: alternateProviderID in: path description: Alternate Provider ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAlternate' text/json: schema: $ref: '#/components/schemas/ProviderAlternate' application/*+json: schema: $ref: '#/components/schemas/ProviderAlternate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAlternateVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAlternateVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAlternateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Alternate summary: Delete ProviderAlternate description: Deletes an ProviderAlternate operationId: DeleteProviderAlternate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: alternateProviderID in: path description: Alternate Provider ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/alternates-batch': put: tags: - Provider Alternate summary: Create or Update Batch ProviderAlternate description: 'Create or Update multiple ProviderAlternate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderAlternate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderAlternate' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderAlternate' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderAlternate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/apcs': post: tags: - Provider APC summary: Create ProviderAPC description: Creates a new ProviderAPC operationId: CreateProviderAPC parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAPC' text/json: schema: $ref: '#/components/schemas/ProviderAPC' application/*+json: schema: $ref: '#/components/schemas/ProviderAPC' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAPCVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAPCVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAPCVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider APC summary: List ProviderAPCs description: List APCs for a given Provider operationId: ListProviderAPC parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAPCListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAPCListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAPCListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/apcs/{providerAPCKey}': get: tags: - Provider APC summary: Get ProviderAPC description: Gets ProviderAPC operationId: GetProviderAPC parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerAPCKey in: path description: ProviderAPC Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAPCVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAPCVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAPCVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider APC summary: Update ProviderAPC description: Updates a specific ProviderAPC. operationId: UpdateProviderAPC parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerAPCKey in: path description: ProviderAPC Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAPC' text/json: schema: $ref: '#/components/schemas/ProviderAPC' application/*+json: schema: $ref: '#/components/schemas/ProviderAPC' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAPCVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAPCVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAPCVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider APC summary: Delete ProviderAPC description: Deletes an ProviderAPC operationId: DeleteProviderAPC parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerAPCKey in: path description: ProviderAPC Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/apcs-batch': put: tags: - Provider APC summary: Create or Update Batch ProviderAPC description: 'Create or Update multiple ProviderAPC at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderAPC parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderAPC' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderAPC' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderAPC' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/auth-exempt-procedures': post: tags: - Provider Auth Exempt Procedures summary: Create ProviderAuthExemptProcedure description: Creates a new ProviderAuthExemptProcedure operationId: CreateProviderAuthExemptProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedure' text/json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedure' application/*+json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedure' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Auth Exempt Procedures summary: List ProviderAuthExemptProcedure description: Lists all ProviderAuthExemptProcedure for the given providerID operationId: ListProviderAuthExemptProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedureListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedureListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedureListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/auth-exempt-procedures/{providerAuthExemptProcedureKey}': get: tags: - Provider Auth Exempt Procedures summary: Get ProviderAuthExemptProcedure description: Gets ProviderAuthExemptProcedure operationId: GetProviderAuthExemptProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerAuthExemptProcedureKey in: path description: ProviderAuthExemptProcedure Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Auth Exempt Procedures summary: Update ProviderAuthExemptProcedure description: Updates a specific ProviderAuthExemptProcedure. operationId: UpdateProviderAuthExemptProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerAuthExemptProcedureKey in: path description: ProviderAuthExemptProcedure Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedure' text/json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedure' application/*+json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedure' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderAuthExemptProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Auth Exempt Procedures summary: Delete ProviderAuthExemptProcedure description: Deletes an ProviderAuthExemptProcedure operationId: DeleteProviderAuthExemptProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerAuthExemptProcedureKey in: path description: ProviderAuthExemptProcedure Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/auth-exempt-procedures-batch': put: tags: - Provider Auth Exempt Procedures summary: Create or Update Batch ProviderAuthExemptProcedure description: 'Create or Update multiple ProviderAuthExemptProcedure at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderAuthExemptProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderAuthExemptProcedure' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderAuthExemptProcedure' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderAuthExemptProcedure' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider/{providerId}/benefit-admin-fees': post: tags: - Provider Benefit Admin Fees summary: Create Provider Benefit Admin Fee description: Creates a new ProviderBenefitAdmin Fee operationId: CreateProviderBenefitAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderBenefitAdmin' text/json: schema: $ref: '#/components/schemas/ProviderBenefitAdmin' application/*+json: schema: $ref: '#/components/schemas/ProviderBenefitAdmin' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderBenefitAdminVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderBenefitAdminVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderBenefitAdminVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Benefit Admin Fees summary: List Provider Benefit Admin Fees description: List All Benefit Admin Fees for a given Provider operationId: ListProviderBenefitAdminFees parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderBenefitAdminListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderBenefitAdminListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderBenefitAdminListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider/{providerId}/benefit-admin-fees/{benefitCode}/{effectiveDate}': get: tags: - Provider Benefit Admin Fees summary: Get ProviderBenefitAdmin description: Gets ProviderBenefitAdmin operationId: GetProviderBenefitAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderBenefitAdminVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderBenefitAdminVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderBenefitAdminVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Benefit Admin Fees summary: Update ProviderBenefitAdmin description: Updates a specific ProviderBenefitAdmin. operationId: UpdateProviderBenefitAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderBenefitAdmin' text/json: schema: $ref: '#/components/schemas/ProviderBenefitAdmin' application/*+json: schema: $ref: '#/components/schemas/ProviderBenefitAdmin' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderBenefitAdminVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderBenefitAdminVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderBenefitAdminVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Benefit Admin Fees summary: Delete ProviderBenefitAdmin description: Deletes an ProviderBenefitAdmin operationId: DeleteProviderBenefitAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider/{providerId}/benefit-admin-fees-batch': put: tags: - Provider Benefit Admin Fees summary: Update Batch ProviderBenefitAdmin description: Updates a multiple ProviderBenefitAdmin. operationId: UpdateBatchProviderBenefitAdmin parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderBenefitAdmin' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderBenefitAdmin' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderBenefitAdmin' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/credentialing': post: tags: - Provider Credentialing summary: Create ProviderCred description: Creates a new ProviderCred operationId: CreateProviderCred parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCred' text/json: schema: $ref: '#/components/schemas/ProviderCred' application/*+json: schema: $ref: '#/components/schemas/ProviderCred' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing summary: List ProviderCred description: Lists all ProviderCred for the given providerID operationId: ListProviderCred parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/credentialing/{providerCredKey}': get: tags: - Provider Credentialing summary: Get ProviderCred description: Gets ProviderCred operationId: GetProviderCred parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing summary: Update ProviderCred description: Updates a specific ProviderCred. operationId: UpdateProviderCred parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCred' text/json: schema: $ref: '#/components/schemas/ProviderCred' application/*+json: schema: $ref: '#/components/schemas/ProviderCred' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing summary: Delete ProviderCred description: Deletes an ProviderCred operationId: DeleteProviderCred parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/credentialing-batch': put: tags: - Provider Credentialing summary: Create or Update Batch ProviderCred description: 'Create or Update multiple ProviderCred at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCred parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCred' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCred' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCred' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/amounts': post: tags: - Provider Credentialing Amounts summary: Create ProviderCredAmount description: Creates a new ProviderCredAmount operationId: CreateProviderCredAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredAmount' text/json: schema: $ref: '#/components/schemas/ProviderCredAmount' application/*+json: schema: $ref: '#/components/schemas/ProviderCredAmount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredAmountVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredAmountVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredAmountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Amounts summary: List ProviderCredAmount description: Lists all ProviderCredAmount for the given providerCredKey operationId: ListProviderCredAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredAmountListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredAmountListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredAmountListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/amounts/{credAmountKey}': get: tags: - Provider Credentialing Amounts summary: Get ProviderCredAmount description: Gets ProviderCredAmount operationId: GetProviderCredAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credAmountKey in: path description: CredAmount Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredAmountVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredAmountVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredAmountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Amounts summary: Update ProviderCredAmount description: Updates a specific ProviderCredAmount. operationId: UpdateProviderCredAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credAmountKey in: path description: CredAmount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredAmount' text/json: schema: $ref: '#/components/schemas/ProviderCredAmount' application/*+json: schema: $ref: '#/components/schemas/ProviderCredAmount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredAmountVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredAmountVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredAmountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Amounts summary: Delete ProviderCredAmount description: Deletes an ProviderCredAmount operationId: DeleteProviderCredAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credAmountKey in: path description: CredAmount Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/amounts-batch': put: tags: - Provider Credentialing Amounts summary: Create or Update Batch ProviderCredAmount description: 'Create or Update multiple ProviderCredAmount at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredAmount' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredAmount' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredAmount' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/attestations': post: tags: - Provider Credentialing Attestations summary: Create ProviderCredAttestation description: Creates a new ProviderCredAttestation operationId: CreateProviderCredAttestation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredAttestation' text/json: schema: $ref: '#/components/schemas/ProviderCredAttestation' application/*+json: schema: $ref: '#/components/schemas/ProviderCredAttestation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredAttestationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredAttestationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredAttestationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Attestations summary: List ProviderCredAttestation description: Lists all ProviderCredAttestation for the given providerCredKey operationId: ListProviderCredAttestation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredAttestationListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredAttestationListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredAttestationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/attestations/{providerCredAttestationKey}': get: tags: - Provider Credentialing Attestations summary: Get ProviderCredAttestation description: Gets ProviderCredAttestation operationId: GetProviderCredAttestation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredAttestationKey in: path description: ProviderCredAttestation Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredAttestationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredAttestationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredAttestationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Attestations summary: Update ProviderCredAttestation description: Updates a specific ProviderCredAttestation. operationId: UpdateProviderCredAttestation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredAttestationKey in: path description: ProviderCredAttestation Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredAttestation' text/json: schema: $ref: '#/components/schemas/ProviderCredAttestation' application/*+json: schema: $ref: '#/components/schemas/ProviderCredAttestation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredAttestationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredAttestationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredAttestationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Attestations summary: Delete ProviderCredAttestation description: Deletes an ProviderCredAttestation operationId: DeleteProviderCredAttestation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredAttestationKey in: path description: ProviderCredAttestation Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/attestations-batch': put: tags: - Provider Credentialing Attestations summary: Create or Update Batch ProviderCredAttestation description: 'Create or Update multiple ProviderCredAttestation at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredAttestation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredAttestation' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredAttestation' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredAttestation' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/certifications': post: tags: - Provider Credentialing Certifications summary: Create ProviderCredCertification description: Creates a new ProviderCredCertification operationId: CreateProviderCredCertification parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredCertification' text/json: schema: $ref: '#/components/schemas/ProviderCredCertification' application/*+json: schema: $ref: '#/components/schemas/ProviderCredCertification' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredCertificationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredCertificationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredCertificationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Certifications summary: List ProviderCredCertification description: Lists all ProviderCredCertification for the given providerCredKey operationId: ListProviderCredCertification parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredCertificationListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredCertificationListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredCertificationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/certifications/{providerCredCertificationKey}': get: tags: - Provider Credentialing Certifications summary: Get ProviderCredCertification description: Gets ProviderCredCertification operationId: GetProviderCredCertification parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredCertificationKey in: path description: ProviderCredCertification Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredCertificationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredCertificationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredCertificationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Certifications summary: Update ProviderCredCertification description: Updates a specific ProviderCredCertification. operationId: UpdateProviderCredCertification parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredCertificationKey in: path description: ProviderCredCertification Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredCertification' text/json: schema: $ref: '#/components/schemas/ProviderCredCertification' application/*+json: schema: $ref: '#/components/schemas/ProviderCredCertification' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredCertificationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredCertificationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredCertificationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Certifications summary: Delete ProviderCredCertification description: Deletes an ProviderCredCertification operationId: DeleteProviderCredCertification parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredCertificationKey in: path description: ProviderCredCertification Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/certifications-batch': put: tags: - Provider Credentialing Certifications summary: Create or Update Batch ProviderCredCertification description: 'Create or Update multiple ProviderCredCertification at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredCertification parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredCertification' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredCertification' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredCertification' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/confidentials': post: tags: - Provider Credentialing Confidentials summary: Create ProviderCredConfidential description: Creates a new ProviderCredConfidential operationId: CreateProviderCredConfidential parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredConfidential' text/json: schema: $ref: '#/components/schemas/ProviderCredConfidential' application/*+json: schema: $ref: '#/components/schemas/ProviderCredConfidential' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredConfidentialVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredConfidentialVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredConfidentialVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Confidentials summary: List ProviderCredConfidential description: Lists all ProviderCredConfidential for the given providerCredKey operationId: ListProviderCredConfidential parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredConfidentialListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredConfidentialListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredConfidentialListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/confidentials/{credConfidentialKey}': get: tags: - Provider Credentialing Confidentials summary: Get ProviderCredConfidential description: Gets ProviderCredConfidential operationId: GetProviderCredConfidential parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credConfidentialKey in: path description: CredConfidential Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredConfidentialVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredConfidentialVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredConfidentialVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Confidentials summary: Delete ProviderCredConfidential description: Deletes an ProviderCredConfidential operationId: DeleteProviderCredConfidential parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credConfidentialKey in: path description: CredConfidential Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/confidentials-batch': put: tags: - Provider Credentialing Confidentials summary: Create Batch ProviderCredConfidential description: 'Create or Update multiple ProviderCredConfidential at once. If the entity does not exist, it will be created.' operationId: CreateBatchProviderCredConfidential parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredConfidential' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredConfidential' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredConfidential' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/contracts': post: tags: - Provider Credentialing Contracts summary: Create ProviderCredContract description: Creates a new ProviderCredContract operationId: CreateProviderCredContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredContract' text/json: schema: $ref: '#/components/schemas/ProviderCredContract' application/*+json: schema: $ref: '#/components/schemas/ProviderCredContract' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredContractVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredContractVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Contracts summary: List ProviderCredContract description: Lists all ProviderCredContract for the given providerCredKey operationId: ListProviderCredContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredContractListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredContractListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredContractListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/contracts/{credContractKey}': get: tags: - Provider Credentialing Contracts summary: Get ProviderCredContract description: Gets ProviderCredContract operationId: GetProviderCredContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credContractKey in: path description: CredContract Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredContractVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredContractVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Contracts summary: Update ProviderCredContract description: Updates a specific ProviderCredContract. operationId: UpdateProviderCredContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credContractKey in: path description: CredContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredContract' text/json: schema: $ref: '#/components/schemas/ProviderCredContract' application/*+json: schema: $ref: '#/components/schemas/ProviderCredContract' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredContractVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredContractVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Contracts summary: Delete ProviderCredContract description: Deletes an ProviderCredContract operationId: DeleteProviderCredContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credContractKey in: path description: CredContract Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/contracts-batch': put: tags: - Provider Credentialing Contracts summary: Create or Update Batch ProviderCredContract description: 'Create or Update multiple ProviderCredContract at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredContract' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredContract' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredContract' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/counties': post: tags: - Provider Credentialing Counties summary: Create ProviderCredCounty description: Creates a new ProviderCredCounty operationId: CreateProviderCredCounty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredCounty' text/json: schema: $ref: '#/components/schemas/ProviderCredCounty' application/*+json: schema: $ref: '#/components/schemas/ProviderCredCounty' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredCountyVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredCountyVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredCountyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Counties summary: List ProviderCredCounty description: Lists all ProviderCredCounty for the given providerCredKey operationId: ListProviderCredCounty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredCountyListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredCountyListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredCountyListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/counties/{countyCode}': get: tags: - Provider Credentialing Counties summary: Get ProviderCredCounty description: Gets ProviderCredCounty operationId: GetProviderCredCounty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: countyCode in: path description: County Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredCountyVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredCountyVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredCountyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Counties summary: Update ProviderCredCounty description: Updates a specific ProviderCredCounty. operationId: UpdateProviderCredCounty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: countyCode in: path description: County Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredCounty' text/json: schema: $ref: '#/components/schemas/ProviderCredCounty' application/*+json: schema: $ref: '#/components/schemas/ProviderCredCounty' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredCountyVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredCountyVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredCountyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Counties summary: Delete ProviderCredCounty description: Deletes an ProviderCredCounty operationId: DeleteProviderCredCounty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: countyCode in: path description: County Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/counties-batch': put: tags: - Provider Credentialing Counties summary: Create or Update Batch ProviderCredCounty description: 'Create or Update multiple ProviderCredCounty at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredCounty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredCounty' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredCounty' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredCounty' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/dates': post: tags: - Provider Credentialing Dates summary: Create ProviderCredDate description: Creates a new ProviderCredDate operationId: CreateProviderCredDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredDate' text/json: schema: $ref: '#/components/schemas/ProviderCredDate' application/*+json: schema: $ref: '#/components/schemas/ProviderCredDate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredDateVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredDateVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredDateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Dates summary: List ProviderCredDate description: Lists all ProviderCredDate for the given providerCredKey operationId: ListProviderCredDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredDateListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredDateListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredDateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/dates/{credDateKey}': get: tags: - Provider Credentialing Dates summary: Get ProviderCredDate description: Gets ProviderCredDate operationId: GetProviderCredDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credDateKey in: path description: CredDate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredDateVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredDateVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredDateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Dates summary: Update ProviderCredDate description: Updates a specific ProviderCredDate. operationId: UpdateProviderCredDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credDateKey in: path description: CredDate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredDate' text/json: schema: $ref: '#/components/schemas/ProviderCredDate' application/*+json: schema: $ref: '#/components/schemas/ProviderCredDate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredDateVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredDateVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredDateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Dates summary: Delete ProviderCredDate description: Deletes an ProviderCredDate operationId: DeleteProviderCredDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credDateKey in: path description: CredDate Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/dates-batch': put: tags: - Provider Credentialing Dates summary: Create or Update Batch ProviderCredDate description: 'Create or Update multiple ProviderCredDate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredDate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredDate' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredDate' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredDate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/education-records': post: tags: - Provider Credentialing Education summary: Create ProviderCredEducation description: Creates a new ProviderCredEducation operationId: CreateProviderCredEducation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredEducation' text/json: schema: $ref: '#/components/schemas/ProviderCredEducation' application/*+json: schema: $ref: '#/components/schemas/ProviderCredEducation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredEducationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredEducationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredEducationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Education summary: List ProviderCredEducation description: Lists all ProviderCredEducation for the given providerCredKey operationId: ListProviderCredEducation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredEducationListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredEducationListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredEducationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/education-records/{providerCredEducationKey}': get: tags: - Provider Credentialing Education summary: Get ProviderCredEducation description: Gets ProviderCredEducation operationId: GetProviderCredEducation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredEducationKey in: path description: ProviderCredEducation Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredEducationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredEducationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredEducationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Education summary: Update ProviderCredEducation description: Updates a specific ProviderCredEducation. operationId: UpdateProviderCredEducation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredEducationKey in: path description: ProviderCredEducation Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredEducation' text/json: schema: $ref: '#/components/schemas/ProviderCredEducation' application/*+json: schema: $ref: '#/components/schemas/ProviderCredEducation' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredEducationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredEducationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredEducationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Education summary: Delete ProviderCredEducation description: Deletes an ProviderCredEducation operationId: DeleteProviderCredEducation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredEducationKey in: path description: ProviderCredEducation Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/education-records-batch': put: tags: - Provider Credentialing Education summary: Create or Update Batch ProviderCredEducation description: 'Create or Update multiple ProviderCredEducation at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredEducation parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredEducation' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredEducation' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredEducation' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/hours': post: tags: - Provider Credentialing Hours summary: Create ProviderCredHours description: Creates a new ProviderCredHours operationId: CreateProviderCredHours parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredHours' text/json: schema: $ref: '#/components/schemas/ProviderCredHours' application/*+json: schema: $ref: '#/components/schemas/ProviderCredHours' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredHoursVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredHoursVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredHoursVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Hours summary: List ProviderCredHours description: Lists all ProviderCredHours for the given providerCredKey operationId: ListProviderCredHours parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredHoursListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredHoursListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredHoursListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/hours/{providerCredHoursKey}': get: tags: - Provider Credentialing Hours summary: Get ProviderCredHours description: Gets ProviderCredHours operationId: GetProviderCredHours parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredHoursKey in: path description: ProviderCredHours Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredHoursVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredHoursVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredHoursVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Hours summary: Update ProviderCredHours description: Updates a specific ProviderCredHours. operationId: UpdateProviderCredHours parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredHoursKey in: path description: ProviderCredHours Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredHours' text/json: schema: $ref: '#/components/schemas/ProviderCredHours' application/*+json: schema: $ref: '#/components/schemas/ProviderCredHours' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredHoursVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredHoursVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredHoursVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Hours summary: Delete ProviderCredHours description: Deletes an ProviderCredHours operationId: DeleteProviderCredHours parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredHoursKey in: path description: ProviderCredHours Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/hours-batch': put: tags: - Provider Credentialing Hours summary: Create or Update Batch ProviderCredHours description: 'Create or Update multiple ProviderCredHours at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredHours parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredHours' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredHours' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredHours' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/hyperlinks': post: tags: - Provider Credentialing Hyperlinks summary: Create ProviderCredHyperlink description: Creates a new ProviderCredHyperlink operationId: CreateProviderCredHyperlink parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredHyperlink' text/json: schema: $ref: '#/components/schemas/ProviderCredHyperlink' application/*+json: schema: $ref: '#/components/schemas/ProviderCredHyperlink' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredHyperlinkVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredHyperlinkVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredHyperlinkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Hyperlinks summary: List ProviderCredHyperlink description: Lists all ProviderCredHyperlink for the given providerCredKey operationId: ListProviderCredHyperlink parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredHyperlinkListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredHyperlinkListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredHyperlinkListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/hyperlinks/{providerCredHyperlinkKey}': get: tags: - Provider Credentialing Hyperlinks summary: Get ProviderCredHyperlink description: Gets ProviderCredHyperlink operationId: GetProviderCredHyperlink parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredHyperlinkKey in: path description: ProviderCredHyperlink Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredHyperlinkVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredHyperlinkVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredHyperlinkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Hyperlinks summary: Update ProviderCredHyperlink description: Updates a specific ProviderCredHyperlink. operationId: UpdateProviderCredHyperlink parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredHyperlinkKey in: path description: ProviderCredHyperlink Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredHyperlink' text/json: schema: $ref: '#/components/schemas/ProviderCredHyperlink' application/*+json: schema: $ref: '#/components/schemas/ProviderCredHyperlink' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredHyperlinkVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredHyperlinkVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredHyperlinkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Hyperlinks summary: Delete ProviderCredHyperlink description: Deletes an ProviderCredHyperlink operationId: DeleteProviderCredHyperlink parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredHyperlinkKey in: path description: ProviderCredHyperlink Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/hyperlinks-batch': put: tags: - Provider Credentialing Hyperlinks summary: Create or Update Batch ProviderCredHyperlink description: 'Create or Update multiple ProviderCredHyperlink at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredHyperlink parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredHyperlink' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredHyperlink' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredHyperlink' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/licenses': post: tags: - Provider Credentialing Licenses summary: Create ProviderCredLicense description: Creates a new ProviderCredLicense operationId: CreateProviderCredLicense parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredLicense' text/json: schema: $ref: '#/components/schemas/ProviderCredLicense' application/*+json: schema: $ref: '#/components/schemas/ProviderCredLicense' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredLicenseVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredLicenseVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredLicenseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Licenses summary: List ProviderCredLicense description: Lists all ProviderCredLicense for the given providerCredKey operationId: ListProviderCredLicense parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredLicenseListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredLicenseListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredLicenseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/licenses/{providerCredLicenseKey}': get: tags: - Provider Credentialing Licenses summary: Get ProviderCredLicense description: Gets ProviderCredLicense operationId: GetProviderCredLicense parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredLicenseKey in: path description: ProviderCredLicense Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredLicenseVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredLicenseVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredLicenseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Licenses summary: Update ProviderCredLicense description: Updates a specific ProviderCredLicense. operationId: UpdateProviderCredLicense parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredLicenseKey in: path description: ProviderCredLicense Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredLicense' text/json: schema: $ref: '#/components/schemas/ProviderCredLicense' application/*+json: schema: $ref: '#/components/schemas/ProviderCredLicense' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredLicenseVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredLicenseVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredLicenseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Licenses summary: Delete ProviderCredLicense description: Deletes an ProviderCredLicense operationId: DeleteProviderCredLicense parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: providerCredLicenseKey in: path description: ProviderCredLicense Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/licenses-batch': put: tags: - Provider Credentialing Licenses summary: Create or Update Batch ProviderCredLicense description: 'Create or Update multiple ProviderCredLicense at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredLicense parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredLicense' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredLicense' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredLicense' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/malpractice': post: tags: - Provider Credentialing Malpractice summary: Create ProviderCredMalpractice description: Creates a new ProviderCredMalpractice operationId: CreateProviderCredMalpractice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredMalpractice' text/json: schema: $ref: '#/components/schemas/ProviderCredMalpractice' application/*+json: schema: $ref: '#/components/schemas/ProviderCredMalpractice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredMalpracticeVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredMalpracticeVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredMalpracticeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Malpractice summary: List ProviderCredMalpractice description: Lists all ProviderCredMalpractice for the given providerCredKey operationId: ListProviderCredMalpractice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredMalpracticeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredMalpracticeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredMalpracticeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/malpractice/{credCarrierKey}/{policyNumber}': get: tags: - Provider Credentialing Malpractice summary: Get ProviderCredMalpractice description: Gets ProviderCredMalpractice operationId: GetProviderCredMalpractice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credCarrierKey in: path description: CredCarrier Key required: true schema: type: integer format: int32 - name: policyNumber in: path description: Policy Number required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredMalpracticeVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredMalpracticeVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredMalpracticeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Malpractice summary: Update ProviderCredMalpractice description: Updates a specific ProviderCredMalpractice. operationId: UpdateProviderCredMalpractice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credCarrierKey in: path description: CredCarrier Key required: true schema: type: integer format: int32 - name: policyNumber in: path description: Policy Number required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredMalpractice' text/json: schema: $ref: '#/components/schemas/ProviderCredMalpractice' application/*+json: schema: $ref: '#/components/schemas/ProviderCredMalpractice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredMalpracticeVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredMalpracticeVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredMalpracticeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Malpractice summary: Delete ProviderCredMalpractice description: Deletes an ProviderCredMalpractice operationId: DeleteProviderCredMalpractice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credCarrierKey in: path description: CredCarrier Key required: true schema: type: integer format: int32 - name: policyNumber in: path description: Policy Number required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/malpractice-batch': put: tags: - Provider Credentialing Malpractice summary: Create or Update Batch ProviderCredMalpractice description: 'Create or Update multiple ProviderCredMalpractice at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredMalpractice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredMalpractice' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredMalpractice' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredMalpractice' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/options': post: tags: - Provider Credentialing Options summary: Create ProviderCredOption description: Creates a new ProviderCredOption operationId: CreateProviderCredOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredOption' text/json: schema: $ref: '#/components/schemas/ProviderCredOption' application/*+json: schema: $ref: '#/components/schemas/ProviderCredOption' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Options summary: List ProviderCredOption description: Lists all ProviderCredOption for the given providerCredKey operationId: ListProviderCredOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/options/{credOptionKey}': get: tags: - Provider Credentialing Options summary: Get ProviderCredOption description: Gets ProviderCredOption operationId: GetProviderCredOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credOptionKey in: path description: CredOption Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Options summary: Update ProviderCredOption description: Updates a specific ProviderCredOption. operationId: UpdateProviderCredOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credOptionKey in: path description: CredOption Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredOption' text/json: schema: $ref: '#/components/schemas/ProviderCredOption' application/*+json: schema: $ref: '#/components/schemas/ProviderCredOption' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Options summary: Delete ProviderCredOption description: Deletes an ProviderCredOption operationId: DeleteProviderCredOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credOptionKey in: path description: CredOption Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/options-batch': put: tags: - Provider Credentialing Options summary: Create or Update Batch ProviderCredOption description: 'Create or Update multiple ProviderCredOption at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredOption' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredOption' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredOption' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/practices': post: tags: - Provider Credentialing Practices summary: Create ProviderCredPracticeDetail description: Creates a new ProviderCredPracticeDetail operationId: CreateProviderCredPracticeDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetail' text/json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetail' application/*+json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredPracticeDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Practices summary: List ProviderCredPracticeDetail description: Lists all ProviderCredPracticeDetail for the given providerCredKey operationId: ListProviderCredPracticeDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredPracticeDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/practices/{credPracticeTypeKey}': get: tags: - Provider Credentialing Practices summary: Get ProviderCredPracticeDetail description: Gets ProviderCredPracticeDetail operationId: GetProviderCredPracticeDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credPracticeTypeKey in: path description: CredPracticeType Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredPracticeDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Practices summary: Update ProviderCredPracticeDetail description: Updates a specific ProviderCredPracticeDetail. operationId: UpdateProviderCredPracticeDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credPracticeTypeKey in: path description: CredPracticeType Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetail' text/json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetail' application/*+json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredPracticeDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredPracticeDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Practices summary: Delete ProviderCredPracticeDetail description: Deletes an ProviderCredPracticeDetail operationId: DeleteProviderCredPracticeDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credPracticeTypeKey in: path description: CredPracticeType Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/practices-batch': put: tags: - Provider Credentialing Practices summary: Create or Update Batch ProviderCredPracticeDetail description: 'Create or Update multiple ProviderCredPracticeDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredPracticeDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredPracticeDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredPracticeDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredPracticeDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/practice-offices': post: tags: - Provider Credentialing Practice Offices summary: Create ProviderCredPracticeOffice description: Creates a new ProviderCredPracticeOffice operationId: CreateProviderCredPracticeOffice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredPracticeOffice' text/json: schema: $ref: '#/components/schemas/ProviderCredPracticeOffice' application/*+json: schema: $ref: '#/components/schemas/ProviderCredPracticeOffice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredPracticeOfficeVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredPracticeOfficeVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredPracticeOfficeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Practice Offices summary: List ProviderCredPracticeOffice description: Lists all ProviderCredPracticeOffice for the given providerCredKey operationId: ListProviderCredPracticeOffice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredPracticeOfficeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredPracticeOfficeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredPracticeOfficeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/practice-offices/{payeeID}': get: tags: - Provider Credentialing Practice Offices summary: Get ProviderCredPracticeOffice description: Gets ProviderCredPracticeOffice operationId: GetProviderCredPracticeOffice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: payeeID in: path description: Payee ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredPracticeOfficeVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredPracticeOfficeVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredPracticeOfficeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Practice Offices summary: Update ProviderCredPracticeOffice description: Updates a specific ProviderCredPracticeOffice. operationId: UpdateProviderCredPracticeOffice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: payeeID in: path description: Payee ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredPracticeOffice' text/json: schema: $ref: '#/components/schemas/ProviderCredPracticeOffice' application/*+json: schema: $ref: '#/components/schemas/ProviderCredPracticeOffice' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredPracticeOfficeVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredPracticeOfficeVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredPracticeOfficeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Practice Offices summary: Delete ProviderCredPracticeOffice description: Deletes an ProviderCredPracticeOffice operationId: DeleteProviderCredPracticeOffice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: payeeID in: path description: Payee ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/practice-offices-batch': put: tags: - Provider Credentialing Practice Offices summary: Create or Update Batch ProviderCredPracticeOffice description: 'Create or Update multiple ProviderCredPracticeOffice at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredPracticeOffice parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredPracticeOffice' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredPracticeOffice' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredPracticeOffice' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/qualities': post: tags: - Provider Credentialing Quality summary: Create ProviderCredQuality description: Creates a new ProviderCredQuality operationId: CreateProviderCredQuality parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredQuality' text/json: schema: $ref: '#/components/schemas/ProviderCredQuality' application/*+json: schema: $ref: '#/components/schemas/ProviderCredQuality' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredQualityVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredQualityVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredQualityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Quality summary: List ProviderCredQuality description: Lists all ProviderCredQuality for the given providerCredKey operationId: ListProviderCredQuality parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredQualityListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredQualityListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredQualityListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/qualities/{credQualityKey}': get: tags: - Provider Credentialing Quality summary: Get ProviderCredQuality description: Gets ProviderCredQuality operationId: GetProviderCredQuality parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credQualityKey in: path description: CredQuality Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredQualityVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredQualityVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredQualityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Quality summary: Update ProviderCredQuality description: Updates a specific ProviderCredQuality. operationId: UpdateProviderCredQuality parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credQualityKey in: path description: CredQuality Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredQuality' text/json: schema: $ref: '#/components/schemas/ProviderCredQuality' application/*+json: schema: $ref: '#/components/schemas/ProviderCredQuality' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredQualityVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredQualityVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredQualityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Quality summary: Delete ProviderCredQuality description: Deletes an ProviderCredQuality operationId: DeleteProviderCredQuality parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credQualityKey in: path description: CredQuality Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/qualities-batch': put: tags: - Provider Credentialing Quality summary: Create or Update Batch ProviderCredQuality description: 'Create or Update multiple ProviderCredQuality at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredQuality parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredQuality' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredQuality' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredQuality' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/services': post: tags: - Provider Credentialing Services summary: Create ProviderCredService description: Creates a new ProviderCredService operationId: CreateProviderCredService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredService' text/json: schema: $ref: '#/components/schemas/ProviderCredService' application/*+json: schema: $ref: '#/components/schemas/ProviderCredService' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredServiceVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredServiceVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredServiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Services summary: List ProviderCredService description: Lists all ProviderCredService for the given providerCredKey operationId: ListProviderCredService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredServiceListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredServiceListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredServiceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/services/{credServiceKey}': get: tags: - Provider Credentialing Services summary: Get ProviderCredService description: Gets ProviderCredService operationId: GetProviderCredService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credServiceKey in: path description: CredService Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredServiceVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredServiceVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredServiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Services summary: Update ProviderCredService description: Updates a specific ProviderCredService. operationId: UpdateProviderCredService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credServiceKey in: path description: CredService Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredService' text/json: schema: $ref: '#/components/schemas/ProviderCredService' application/*+json: schema: $ref: '#/components/schemas/ProviderCredService' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredServiceVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredServiceVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredServiceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Services summary: Delete ProviderCredService description: Deletes an ProviderCredService operationId: DeleteProviderCredService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credServiceKey in: path description: CredService Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/services-batch': put: tags: - Provider Credentialing Services summary: Create or Update Batch ProviderCredService description: 'Create or Update multiple ProviderCredService at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredService parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredService' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredService' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredService' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/techniques': post: tags: - Provider Credentialing Techniques summary: Create ProviderCredTechnique description: Creates a new ProviderCredTechnique operationId: CreateProviderCredTechnique parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredTechnique' text/json: schema: $ref: '#/components/schemas/ProviderCredTechnique' application/*+json: schema: $ref: '#/components/schemas/ProviderCredTechnique' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredTechniqueVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredTechniqueVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredTechniqueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Techniques summary: List ProviderCredTechnique description: Lists all ProviderCredTechnique for the given providerCredKey operationId: ListProviderCredTechnique parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredTechniqueListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredTechniqueListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredTechniqueListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/techniques/{credTechniqueKey}': get: tags: - Provider Credentialing Techniques summary: Get ProviderCredTechnique description: Gets ProviderCredTechnique operationId: GetProviderCredTechnique parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credTechniqueKey in: path description: CredTechnique Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredTechniqueVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredTechniqueVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredTechniqueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Techniques summary: Update ProviderCredTechnique description: Updates a specific ProviderCredTechnique. operationId: UpdateProviderCredTechnique parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credTechniqueKey in: path description: CredTechnique Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredTechnique' text/json: schema: $ref: '#/components/schemas/ProviderCredTechnique' application/*+json: schema: $ref: '#/components/schemas/ProviderCredTechnique' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredTechniqueVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredTechniqueVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredTechniqueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Techniques summary: Delete ProviderCredTechnique description: Deletes an ProviderCredTechnique operationId: DeleteProviderCredTechnique parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: credTechniqueKey in: path description: CredTechnique Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/techniques-batch': put: tags: - Provider Credentialing Techniques summary: Create or Update Batch ProviderCredTechnique description: 'Create or Update multiple ProviderCredTechnique at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredTechnique parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredTechnique' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredTechnique' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredTechnique' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/terminations': post: tags: - Provider Credentialing Terminations summary: Create ProviderCredTermination description: Creates a new ProviderCredTermination operationId: CreateProviderCredTermination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredTermination' text/json: schema: $ref: '#/components/schemas/ProviderCredTermination' application/*+json: schema: $ref: '#/components/schemas/ProviderCredTermination' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredTerminationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredTerminationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredTerminationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Credentialing Terminations summary: List ProviderCredTermination description: Lists all ProviderCredTermination for the given providerCredKey operationId: ListProviderCredTermination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredTerminationListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredTerminationListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredTerminationListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/terminations/{networkID}/{credTerminationKey}': get: tags: - Provider Credentialing Terminations summary: Get ProviderCredTermination description: Gets ProviderCredTermination operationId: GetProviderCredTermination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: networkID in: path description: Network ID required: true schema: type: string - name: credTerminationKey in: path description: CredTermination Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredTerminationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredTerminationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredTerminationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Credentialing Terminations summary: Update ProviderCredTermination description: Updates a specific ProviderCredTermination. operationId: UpdateProviderCredTermination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: networkID in: path description: Network ID required: true schema: type: string - name: credTerminationKey in: path description: CredTermination Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderCredTermination' text/json: schema: $ref: '#/components/schemas/ProviderCredTermination' application/*+json: schema: $ref: '#/components/schemas/ProviderCredTermination' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderCredTerminationVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderCredTerminationVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderCredTerminationVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Credentialing Terminations summary: Delete ProviderCredTermination description: Deletes an ProviderCredTermination operationId: DeleteProviderCredTermination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 - name: networkID in: path description: Network ID required: true schema: type: string - name: credTerminationKey in: path description: CredTermination Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-credentialing/{providerCredKey}/terminations-batch': put: tags: - Provider Credentialing Terminations summary: Create or Update Batch ProviderCredTermination description: 'Create or Update multiple ProviderCredTermination at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderCredTermination parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerCredKey in: path description: ProviderCred Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredTermination' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderCredTermination' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderCredTermination' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/drgs': post: tags: - Provider DRG summary: Create ProviderDRG description: Creates a new ProviderDRG operationId: CreateProviderDRG parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderDRG' text/json: schema: $ref: '#/components/schemas/ProviderDRG' application/*+json: schema: $ref: '#/components/schemas/ProviderDRG' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderDRGVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderDRGVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderDRGVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider DRG summary: List ProviderDRGs description: List all ProviderDRG for a specific Provider operationId: ListProviderDRG parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderDRGListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderDRGListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderDRGListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/drgs/{providerDRGKey}': get: tags: - Provider DRG summary: Get ProviderDRG description: Gets ProviderDRG operationId: GetProviderDRG parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerDRGKey in: path description: ProviderDRG Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderDRGVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderDRGVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderDRGVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider DRG summary: Update ProviderDRG description: Updates a specific ProviderDRG. operationId: UpdateProviderDRG parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerDRGKey in: path description: ProviderDRG Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderDRG' text/json: schema: $ref: '#/components/schemas/ProviderDRG' application/*+json: schema: $ref: '#/components/schemas/ProviderDRG' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderDRGVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderDRGVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderDRGVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider DRG summary: Delete ProviderDRG description: Deletes an ProviderDRG operationId: DeleteProviderDRG parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerDRGKey in: path description: ProviderDRG Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/drgs-batch': put: tags: - Provider DRG summary: Create or Update Batch ProviderDRG description: 'Create or Update multiple ProviderDRG at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderDRG parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderDRG' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderDRG' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderDRG' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/languages': post: tags: - Provider Languages summary: Create ProviderLanguages description: Creates a new ProviderLanguages operationId: CreateProviderLanguages parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderLanguages' text/json: schema: $ref: '#/components/schemas/ProviderLanguages' application/*+json: schema: $ref: '#/components/schemas/ProviderLanguages' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderLanguagesVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderLanguagesVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderLanguagesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Languages summary: List ProviderLanguages description: Lists all ProviderLanguages for the given providerID operationId: ListProviderLanguages parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderLanguagesListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderLanguagesListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderLanguagesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/languages/{languageID}': get: tags: - Provider Languages summary: Get ProviderLanguages description: Gets ProviderLanguages operationId: GetProviderLanguages parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: languageID in: path description: Language ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderLanguagesVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderLanguagesVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderLanguagesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Languages summary: Update ProviderLanguages description: Updates a specific ProviderLanguages. operationId: UpdateProviderLanguages parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: languageID in: path description: Language ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderLanguages' text/json: schema: $ref: '#/components/schemas/ProviderLanguages' application/*+json: schema: $ref: '#/components/schemas/ProviderLanguages' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderLanguagesVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderLanguagesVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderLanguagesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Languages summary: Delete ProviderLanguages description: Deletes an ProviderLanguages operationId: DeleteProviderLanguages parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: languageID in: path description: Language ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/languages-batch': put: tags: - Provider Languages summary: Create or Update Batch ProviderLanguages description: 'Create or Update multiple ProviderLanguages at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderLanguages parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderLanguages' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderLanguages' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderLanguages' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/networks/{networkId}': post: tags: - Provider Network summary: Create ProviderNetwork description: Creates a new ProviderNetwork by assigning an existing Network to a Provider for a given Effective Date. operationId: CreateProviderNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: networkId in: path description: Network ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderNetwork' text/json: schema: $ref: '#/components/schemas/ProviderNetwork' application/*+json: schema: $ref: '#/components/schemas/ProviderNetwork' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/networks/{networkId}/effective-date/{effectiveDate}': get: tags: - Provider Network summary: Get ProviderNetwork description: Gets ProviderNetwork operationId: GetProviderNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: networkId in: path description: Network ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Network summary: Update ProviderNetwork description: 'Updates a specific ProviderNetwork. Note: The Provider ID, Network ID and Effective Date cannot be changed.' operationId: UpdateProviderNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: networkId in: path description: Network ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderNetwork' text/json: schema: $ref: '#/components/schemas/ProviderNetwork' application/*+json: schema: $ref: '#/components/schemas/ProviderNetwork' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Network summary: Delete ProviderNetwork description: Deletes an ProviderNetwork operationId: DeleteProviderNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: networkId in: path description: Network ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/networks': get: tags: - Provider Network summary: List ProviderNetworks by Provider description: Gets a List of ProviderNetworks for a given Provider ID operationId: ListProviderNetworksForProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderNetworkListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderNetworkListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderNetworkListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Network summary: Update Batch ProviderNetwork description: Updates a multiple ProviderNetwork. operationId: UpdateBatchProviderNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderNetwork' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderNetwork' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderNetwork' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/networks/{networkID}/modifiers/{modifier}': post: tags: - Provider Network Modifier summary: Create ProviderNetworkModifier description: Creates a new ProviderNetworkModifier operationId: CreateProviderNetworkModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: modifier in: path description: Modifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderNetworkModifier' text/json: schema: $ref: '#/components/schemas/ProviderNetworkModifier' application/*+json: schema: $ref: '#/components/schemas/ProviderNetworkModifier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderNetworkModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderNetworkModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderNetworkModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/networks/{networkID}/modifiers': get: tags: - Provider Network Modifier summary: List ProviderNetworkModifier description: 'Lists all ProviderNetworkModifier for the given Provider ID, and Network ID' operationId: ListProviderNetworkModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderNetworkModifierListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderNetworkModifierListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderNetworkModifierListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/network-modifiers': get: tags: - Provider Network Modifier summary: List ProviderNetworkModifier for a given provider id description: Lists all ProviderNetworkModifier for the given Provider ID. This will include all assigned Networks. operationId: ListProviderNetworkModifiersForProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderNetworkModifierListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderNetworkModifierListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderNetworkModifierListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/networks/{networkID}/modifiers/{modifier}/effective-date/{effectiveDate}': get: tags: - Provider Network Modifier summary: Get ProviderNetworkModifier description: Gets ProviderNetworkModifier operationId: GetProviderNetworkModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: modifier in: path description: Modifier required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderNetworkModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderNetworkModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderNetworkModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Network Modifier summary: Update ProviderNetworkModifier description: Updates a specific ProviderNetworkModifier. operationId: UpdateProviderNetworkModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: modifier in: path description: Modifier required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderNetworkModifier' text/json: schema: $ref: '#/components/schemas/ProviderNetworkModifier' application/*+json: schema: $ref: '#/components/schemas/ProviderNetworkModifier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderNetworkModifierVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderNetworkModifierVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderNetworkModifierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Network Modifier summary: Delete ProviderNetworkModifier description: Deletes an ProviderNetworkModifier operationId: DeleteProviderNetworkModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string - name: modifier in: path description: Modifier required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/networks/{networkID}/modifiers-batch': put: tags: - Provider Network Modifier summary: Create or Update Batch ProviderNetworkModifier description: 'Create or Update multiple ProviderNetworkModifier at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderNetworkModifier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: networkID in: path description: Network ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderNetworkModifier' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderNetworkModifier' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderNetworkModifier' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/payees': post: tags: - Provider Payees summary: Create ProviderPayee description: Creates a new ProviderPayee operationId: CreateProviderPayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderPayee' text/json: schema: $ref: '#/components/schemas/ProviderPayee' application/*+json: schema: $ref: '#/components/schemas/ProviderPayee' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderPayeeVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderPayeeVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderPayeeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Payees summary: List ProviderPayee description: Lists all ProviderPayee for the given providerID operationId: ListProviderPayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderPayeeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderPayeeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderPayeeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/payees/{payeeID}/{effectiveDate}': get: tags: - Provider Payees summary: Get ProviderPayee description: Gets ProviderPayee operationId: GetProviderPayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: payeeID in: path description: Payee ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderPayeeVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderPayeeVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderPayeeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Payees summary: Update ProviderPayee description: Updates a specific ProviderPayee. operationId: UpdateProviderPayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: payeeID in: path description: Payee ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderPayee' text/json: schema: $ref: '#/components/schemas/ProviderPayee' application/*+json: schema: $ref: '#/components/schemas/ProviderPayee' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderPayeeVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderPayeeVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderPayeeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Payees summary: Delete ProviderPayee description: Deletes an ProviderPayee operationId: DeleteProviderPayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: payeeID in: path description: Payee ID required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/payees-batch': put: tags: - Provider Payees summary: Create or Update Batch ProviderPayee description: 'Create or Update multiple ProviderPayee at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderPayee parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderPayee' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderPayee' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderPayee' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/per-diems': post: tags: - Provider Per Diem summary: Create ProviderPerDiem description: Creates a new ProviderPerDiem operationId: CreateProviderPerDiem parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderPerDiem' text/json: schema: $ref: '#/components/schemas/ProviderPerDiem' application/*+json: schema: $ref: '#/components/schemas/ProviderPerDiem' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderPerDiemVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderPerDiemVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderPerDiemVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Per Diem summary: List ProviderPerDiem description: List ProviderPerDiem for a specific Provider operationId: ListProviderPerDiem parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderPerDiemListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderPerDiemListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderPerDiemListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/per-diems/{providerPerDiemKey}': get: tags: - Provider Per Diem summary: Get ProviderPerDiem description: Gets ProviderPerDiem operationId: GetProviderPerDiem parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerPerDiemKey in: path description: ProviderPerDiem Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderPerDiemVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderPerDiemVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderPerDiemVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Per Diem summary: Update ProviderPerDiem description: Updates a specific ProviderPerDiem. operationId: UpdateProviderPerDiem parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerPerDiemKey in: path description: ProviderPerDiem Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderPerDiem' text/json: schema: $ref: '#/components/schemas/ProviderPerDiem' application/*+json: schema: $ref: '#/components/schemas/ProviderPerDiem' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderPerDiemVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderPerDiemVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderPerDiemVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Per Diem summary: Delete ProviderPerDiem description: Deletes an ProviderPerDiem operationId: DeleteProviderPerDiem parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerPerDiemKey in: path description: ProviderPerDiem Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/per-diems-batch': put: tags: - Provider Per Diem summary: Create or Update Batch ProviderPerDiem description: 'Create or Update multiple ProviderPerDiem at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderPerDiem parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderPerDiem' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderPerDiem' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderPerDiem' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/per-diems/{providerPerDiemKey}/procedures': post: tags: - Provider Per Diem Procedure summary: Create ProviderPerDiemProcedure description: Creates a new ProviderPerDiemProcedure operationId: CreateProviderPerDiemProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerPerDiemKey in: path description: ProviderPerDiem Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderPerDiemProcedure' text/json: schema: $ref: '#/components/schemas/ProviderPerDiemProcedure' application/*+json: schema: $ref: '#/components/schemas/ProviderPerDiemProcedure' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderPerDiemProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderPerDiemProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderPerDiemProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Per Diem Procedure summary: List ProviderPerDiemProcedure description: Lists all ProviderPerDiemProcedure for the given providerPerDiemKey operationId: ListProviderPerDiemProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerPerDiemKey in: path description: ProviderPerDiem Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderPerDiemProcedureListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderPerDiemProcedureListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderPerDiemProcedureListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/per-diems/{providerPerDiemKey}/procedures/{fromProcedure}-{thruProcedure}': get: tags: - Provider Per Diem Procedure summary: Get ProviderPerDiemProcedure description: Gets ProviderPerDiemProcedure operationId: GetProviderPerDiemProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerPerDiemKey in: path description: ProviderPerDiem Key required: true schema: type: integer format: int32 - name: fromProcedure in: path description: From Procedure required: true schema: type: string - name: thruProcedure in: path description: Thru Procedure required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderPerDiemProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderPerDiemProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderPerDiemProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Per Diem Procedure summary: Delete ProviderPerDiemProcedure description: Deletes an ProviderPerDiemProcedure operationId: DeleteProviderPerDiemProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerPerDiemKey in: path description: ProviderPerDiem Key required: true schema: type: integer format: int32 - name: fromProcedure in: path description: From Procedure required: true schema: type: string - name: thruProcedure in: path description: Thru Procedure required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/per-diems/{providerPerDiemKey}/procedures-batch': put: tags: - Provider Per Diem Procedure summary: Create or Update Batch ProviderPerDiemProcedure description: 'Create or Update multiple ProviderPerDiemProcedure at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderPerDiemProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerPerDiemKey in: path description: ProviderPerDiem Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderPerDiemProcedure' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderPerDiemProcedure' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderPerDiemProcedure' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-profiles/{profileProviderId}/provider-addresses/{addressProviderId}': post: tags: - Provider Profile summary: Create ProviderProfile description: Creates a new ProviderProfile operationId: CreateProviderProfile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: profileProviderId in: path description: Profile Provider ID required: true schema: type: string - name: addressProviderId in: path description: Address Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderProfileVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderProfileVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderProfileVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Profile summary: Delete ProviderProfile description: Deletes an ProviderProfile operationId: DeleteProviderProfile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: profileProviderId in: path description: Profile Provider ID required: true schema: type: string - name: addressProviderId in: path description: Address Provider ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-profiles/{profileProviderId}': get: tags: - Provider Profile summary: Get ProviderProfile description: Gets ProviderProfile operationId: GetProviderProfile parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: profileProviderId in: path description: Profile Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProfileProvider_AddressProviderVBAResponse' application/json: schema: $ref: '#/components/schemas/ProfileProvider_AddressProviderVBAResponse' text/json: schema: $ref: '#/components/schemas/ProfileProvider_AddressProviderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/rates': post: tags: - Provider Rates summary: Create Provider Rate description: Creates a new Provider Rate operationId: CreateProviderRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderRate' text/json: schema: $ref: '#/components/schemas/ProviderRate' application/*+json: schema: $ref: '#/components/schemas/ProviderRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Rates summary: List Provider Rates description: List Provider Rates operationId: ListProviderRates parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/rates/{providerRateKey}': get: tags: - Provider Rates summary: Get Provider Rate description: Gets Provider Rate operationId: GetProviderRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: ProviderRate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Rates summary: Update ProviderRate description: Updates a specific ProviderRate. operationId: UpdateProviderRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: ProviderRate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderRate' text/json: schema: $ref: '#/components/schemas/ProviderRate' application/*+json: schema: $ref: '#/components/schemas/ProviderRate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Rates summary: Delete ProviderRate description: Deletes an ProviderRate operationId: DeleteProviderRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: ProviderRate Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/rates-batch': put: tags: - Provider Rates summary: Update Batch ProviderRate description: Updates a multiple ProviderRate. operationId: UpdateBatchProviderRate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderRate' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderRate' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderRate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/rates/{providerRateKey}/adjustments': post: tags: - Provider Rate Adjustments summary: Create ProviderRateAdjust description: Creates a new ProviderRateAdjust operationId: CreateProviderRateAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: Provider Rate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderRateAdjust' text/json: schema: $ref: '#/components/schemas/ProviderRateAdjust' application/*+json: schema: $ref: '#/components/schemas/ProviderRateAdjust' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateAdjustVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateAdjustVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateAdjustVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Rate Adjustments summary: List Provider Rate Adjustments description: 'List Adjustments for a specific Provider Rate ' operationId: ListProviderRateAdjustments parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: Provider Rate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateAdjustListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateAdjustListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateAdjustListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/rates/{providerRateKey}/adjustments/{providerRateAdjustKey}': get: tags: - Provider Rate Adjustments summary: Get ProviderRateAdjust description: Gets ProviderRateAdjust operationId: GetProviderRateAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: Provider Rate Key required: true schema: type: integer format: int32 - name: providerRateAdjustKey in: path description: Provider Rate Adjust Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateAdjustVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateAdjustVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateAdjustVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Rate Adjustments summary: Update ProviderRateAdjust description: Updates a specific ProviderRateAdjust. operationId: UpdateProviderRateAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: Provider Rate Key required: true schema: type: integer format: int32 - name: providerRateAdjustKey in: path description: Provider Rate Adjust Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderRateAdjust' text/json: schema: $ref: '#/components/schemas/ProviderRateAdjust' application/*+json: schema: $ref: '#/components/schemas/ProviderRateAdjust' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateAdjustVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateAdjustVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateAdjustVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Rate Adjustments summary: Delete ProviderRateAdjust description: Deletes an ProviderRateAdjust operationId: DeleteProviderRateAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: Provider Rate Key required: true schema: type: integer format: int32 - name: providerRateAdjustKey in: path description: Provider Rate Adjust Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/rates/{providerRateKey}/adjustments-batch': put: tags: - Provider Rate Adjustments summary: Update Batch ProviderRateAdjust description: Create or Update multiple ProviderRateAdjust. operationId: UpdateBatchProviderRateAdjust parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: Provider Rate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderRateAdjust' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderRateAdjust' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderRateAdjust' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-rate-columns/{providerRateColumnKey}': get: tags: - Provider Rate Column summary: Get Provider Rate Column description: Gets Provider Rate Column operationId: GetProviderRateColumn parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerRateColumnKey in: path description: Provider Rate Column Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateColumnVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateColumnVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateColumnVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /provider-rate-columns: get: tags: - Provider Rate Column summary: List Provider Rate Columns description: List all Provider Rate Columns operationId: ListProviderRateColumns parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateColumnListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateColumnListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateColumnListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/rates/{providerRateKey}/criterias': post: tags: - Provider Rate Criteria summary: Create Provider Rate Criteria description: Creates a new Provider Rate Criteria operationId: CreateProviderRateCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: Provider Rate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderRateCriteria' text/json: schema: $ref: '#/components/schemas/ProviderRateCriteria' application/*+json: schema: $ref: '#/components/schemas/ProviderRateCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Rate Criteria summary: List ProviderRateCriteria description: Lists all ProviderRateCriteria given a ProviderID and ProviderRateKey operationId: ListProviderRateCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: Provider Rate Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateCriteriaListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateCriteriaListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateCriteriaListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/rates/{providerRateKey}/criterias/{providerRateCriteriaKey}': get: tags: - Provider Rate Criteria summary: Get ProviderRateCriteria description: Gets ProviderRateCriteria operationId: GetProviderRateCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: Provider Rate Key required: true schema: type: integer format: int32 - name: providerRateCriteriaKey in: path description: ProviderRateCriteria Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Rate Criteria summary: Update ProviderRateCriteria description: Updates a specific ProviderRateCriteria. operationId: UpdateProviderRateCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: Provider Rate Key required: true schema: type: integer format: int32 - name: providerRateCriteriaKey in: path description: ProviderRateCriteria Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderRateCriteria' text/json: schema: $ref: '#/components/schemas/ProviderRateCriteria' application/*+json: schema: $ref: '#/components/schemas/ProviderRateCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRateCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRateCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRateCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Rate Criteria summary: Delete ProviderRateCriteria description: Deletes an ProviderRateCriteria operationId: DeleteProviderRateCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: Provider Rate Key required: true schema: type: integer format: int32 - name: providerRateCriteriaKey in: path description: ProviderRateCriteria Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/rates/{providerRateKey}/criterias-batch': put: tags: - Provider Rate Criteria summary: Update Batch ProviderRateCriteria description: Updates a multiple ProviderRateCriteria. operationId: UpdateBatchProviderRateCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider ID required: true schema: type: string - name: providerRateKey in: path description: Provider Rate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderRateCriteria' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderRateCriteria' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderRateCriteria' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /provider-roles: post: tags: - Provider Roles summary: Create ProviderRole description: Creates a new ProviderRole operationId: CreateProviderRole parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderRole' text/json: schema: $ref: '#/components/schemas/ProviderRole' application/*+json: schema: $ref: '#/components/schemas/ProviderRole' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRoleVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRoleVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRoleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Roles summary: List ProviderRole description: Lists all ProviderRole operationId: ListProviderRole parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRoleListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRoleListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRoleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-roles/{providerRoleID}': get: tags: - Provider Roles summary: Get ProviderRole description: Gets ProviderRole operationId: GetProviderRole parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerRoleID in: path description: Provider Role ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRoleVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRoleVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRoleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Roles summary: Update ProviderRole description: Updates a specific ProviderRole. operationId: UpdateProviderRole parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerRoleID in: path description: Provider Role ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderRole' text/json: schema: $ref: '#/components/schemas/ProviderRole' application/*+json: schema: $ref: '#/components/schemas/ProviderRole' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderRoleVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderRoleVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderRoleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Roles summary: Delete ProviderRole description: Deletes an ProviderRole operationId: DeleteProviderRole parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerRoleID in: path description: Provider Role ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /provider-roles-batch: put: tags: - Provider Roles summary: Create or Update Batch ProviderRole description: 'Create or Update multiple ProviderRole at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderRole parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderRole' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderRole' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderRole' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/specialties/{specialtyCode}': post: tags: - Provider Specialty summary: Create ProviderSpecialty description: Creates a new ProviderSpecialty by assigning an existing Specialty to a Provider. operationId: CreateProviderSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider id required: true schema: type: string - name: specialtyCode in: path description: Specialty Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderSpecialtyVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderSpecialtyVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderSpecialtyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Specialty summary: Get ProviderSpecialty description: Gets ProviderSpecialty operationId: GetProviderSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider id required: true schema: type: string - name: specialtyCode in: path description: Specialty Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderSpecialtyVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderSpecialtyVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderSpecialtyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Specialty summary: Delete ProviderSpecialty description: Deletes an ProviderSpecialty operationId: DeleteProviderSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider id required: true schema: type: string - name: specialtyCode in: path description: Specialty Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/specialties': get: tags: - Provider Specialty summary: List ProviderSpecialty by Provider description: Gets a List of ProviderSpecialty for a given Provider ID operationId: ListProviderSpecialtiesForProvider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider id required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderSpecialtyListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderSpecialtyListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderSpecialtyListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerId}/specialties-batch': put: tags: - Provider Specialty summary: Create Batch ProviderSpecialty description: Creates multiple ProviderSpecialties at one time. operationId: CreateBatchProviderSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: path description: Provider id required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderSpecialty' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderSpecialty' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderSpecialty' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /provider-rate-types: get: tags: - Provider Rate Types summary: List Provider Rate Types description: Lists all Provider Rate Types operationId: ListProviderRateTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/suffixes': post: tags: - Provider Suffix summary: Create ProviderSuffix description: Creates a new ProviderSuffix operationId: CreateProviderSuffix parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderSuffix' text/json: schema: $ref: '#/components/schemas/ProviderSuffix' application/*+json: schema: $ref: '#/components/schemas/ProviderSuffix' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderSuffixVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderSuffixVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderSuffixVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Suffix summary: List ProviderSuffix description: Lists all ProviderSuffix given a specific providerID operationId: ListProviderSuffixes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderSuffixListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderSuffixListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderSuffixListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/suffixes/{suffix}': get: tags: - Provider Suffix summary: Get ProviderSuffix description: Gets ProviderSuffix operationId: GetProviderSuffix parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: suffix in: path description: Suffix required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderSuffixVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderSuffixVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderSuffixVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Suffix summary: Update ProviderSuffix description: Updates a specific ProviderSuffix. operationId: UpdateProviderSuffix parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: suffix in: path description: Suffix required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderSuffix' text/json: schema: $ref: '#/components/schemas/ProviderSuffix' application/*+json: schema: $ref: '#/components/schemas/ProviderSuffix' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderSuffixVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderSuffixVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderSuffixVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Suffix summary: Delete ProviderSuffix description: Deletes an ProviderSuffix operationId: DeleteProviderSuffix parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: suffix in: path description: Suffix required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/suffixes-batch': put: tags: - Provider Suffix summary: Create or Update Batch ProviderSuffix description: 'Create or Update multiple ProviderSuffix at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderSuffix parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderSuffix' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderSuffix' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderSuffix' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/taxonomies': post: tags: - Provider Taxonomy summary: Create ProviderTaxonomy description: Creates a new ProviderTaxonomy operationId: CreateProviderTaxonomy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderTaxonomy' text/json: schema: $ref: '#/components/schemas/ProviderTaxonomy' application/*+json: schema: $ref: '#/components/schemas/ProviderTaxonomy' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderTaxonomyVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderTaxonomyVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderTaxonomyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Taxonomy summary: List ProviderTaxonomy description: Lists all ProviderTaxonomy given a specific providerID operationId: ListProviderTaxonomies parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderTaxonomyListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderTaxonomyListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderTaxonomyListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/taxonomies/{providerTaxonomyKey}': get: tags: - Provider Taxonomy summary: Get ProviderTaxonomy description: Gets ProviderTaxonomy operationId: GetProviderTaxonomy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerTaxonomyKey in: path description: ProviderTaxonomy Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderTaxonomyVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderTaxonomyVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderTaxonomyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Taxonomy summary: Update ProviderTaxonomy description: Updates a specific ProviderTaxonomy. operationId: UpdateProviderTaxonomy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerTaxonomyKey in: path description: ProviderTaxonomy Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderTaxonomy' text/json: schema: $ref: '#/components/schemas/ProviderTaxonomy' application/*+json: schema: $ref: '#/components/schemas/ProviderTaxonomy' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderTaxonomyVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderTaxonomyVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderTaxonomyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Taxonomy summary: Delete ProviderTaxonomy description: Deletes an ProviderTaxonomy operationId: DeleteProviderTaxonomy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string - name: providerTaxonomyKey in: path description: ProviderTaxonomy Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/providers/{providerID}/taxonomies-batch': put: tags: - Provider Taxonomy summary: Create or Update Batch ProviderTaxonomy description: 'Create or Update multiple ProviderTaxonomy at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderTaxonomy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerID in: path description: Provider ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderTaxonomy' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderTaxonomy' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderTaxonomy' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /provider-types: post: tags: - Provider Types summary: Create ProviderTypes description: Creates a new ProviderTypes operationId: CreateProviderTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderTypes' text/json: schema: $ref: '#/components/schemas/ProviderTypes' application/*+json: schema: $ref: '#/components/schemas/ProviderTypes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderTypesVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderTypesVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderTypesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Types summary: List ProviderTypes description: 'Lists all ProviderTypes ' operationId: ListProviderTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderTypesListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderTypesListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderTypesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-types/{providerType}': get: tags: - Provider Types summary: Get ProviderTypes description: Gets ProviderTypes operationId: GetProviderTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerType in: path description: Provider Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderTypesVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderTypesVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderTypesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Types summary: Update ProviderTypes description: Updates a specific ProviderTypes. operationId: UpdateProviderTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerType in: path description: Provider Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderTypes' text/json: schema: $ref: '#/components/schemas/ProviderTypes' application/*+json: schema: $ref: '#/components/schemas/ProviderTypes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderTypesVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderTypesVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderTypesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Types summary: Delete ProviderTypes description: Deletes an ProviderTypes operationId: DeleteProviderTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerType in: path description: Provider Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /provider-types-batch: put: tags: - Provider Types summary: Create or Update Batch ProviderTypes description: 'Create or Update multiple ProviderTypes at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderTypes' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderTypes' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderTypes' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /provider-withholds: post: tags: - Provider Withholds summary: Create ProviderWithhold description: Creates a new ProviderWithhold operationId: CreateProviderWithhold parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderWithhold' text/json: schema: $ref: '#/components/schemas/ProviderWithhold' application/*+json: schema: $ref: '#/components/schemas/ProviderWithhold' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderWithholdVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderWithholdVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderWithholdVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Provider Withholds summary: List ProviderWithhold description: Lists all ProviderWithhold. Supply optional ProviderID and/or FederalID parameters to filter results. operationId: ListProviderWithhold parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerId in: query description: ProviderID schema: type: string - name: federalId in: query description: FederalID schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderWithholdListVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderWithholdListVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderWithholdListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/provider-withholds/{providerWithholdKey}': get: tags: - Provider Withholds summary: Get ProviderWithhold description: Gets ProviderWithhold operationId: GetProviderWithhold parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerWithholdKey in: path description: ProviderWithhold Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderWithholdVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderWithholdVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderWithholdVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Provider Withholds summary: Update ProviderWithhold description: Updates a specific ProviderWithhold. operationId: UpdateProviderWithhold parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerWithholdKey in: path description: ProviderWithhold Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderWithhold' text/json: schema: $ref: '#/components/schemas/ProviderWithhold' application/*+json: schema: $ref: '#/components/schemas/ProviderWithhold' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ProviderWithholdVBAResponse' application/json: schema: $ref: '#/components/schemas/ProviderWithholdVBAResponse' text/json: schema: $ref: '#/components/schemas/ProviderWithholdVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Provider Withholds summary: Delete ProviderWithhold description: Deletes an ProviderWithhold operationId: DeleteProviderWithhold parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: providerWithholdKey in: path description: ProviderWithhold Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /provider-withholds-batch: put: tags: - Provider Withholds summary: Create or Update Batch ProviderWithhold description: 'Create or Update multiple ProviderWithhold at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchProviderWithhold parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderWithhold' text/json: schema: type: array items: $ref: '#/components/schemas/ProviderWithhold' application/*+json: schema: type: array items: $ref: '#/components/schemas/ProviderWithhold' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /purposes: get: tags: - Objects summary: List Purposes description: Gets a list of all Purposes operationId: ListPurposes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PurposeListVBAResponse' application/json: schema: $ref: '#/components/schemas/PurposeListVBAResponse' text/json: schema: $ref: '#/components/schemas/PurposeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reasons: post: tags: - Reasons summary: Create Reasons description: Creates a new Reasons operationId: CreateReasons parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Reasons' text/json: schema: $ref: '#/components/schemas/Reasons' application/*+json: schema: $ref: '#/components/schemas/Reasons' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReasonsVBAResponse' application/json: schema: $ref: '#/components/schemas/ReasonsVBAResponse' text/json: schema: $ref: '#/components/schemas/ReasonsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reasons summary: List Reasons description: 'Lists all Reasons ' operationId: ListReasons parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReasonsListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReasonsListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReasonsListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reasons/{reasonID}': get: tags: - Reasons summary: Get Reasons description: Gets Reasons operationId: GetReasons parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reasonID in: path description: Reason ID required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReasonsVBAResponse' application/json: schema: $ref: '#/components/schemas/ReasonsVBAResponse' text/json: schema: $ref: '#/components/schemas/ReasonsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reasons summary: Update Reasons description: Updates a specific Reasons. operationId: UpdateReasons parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reasonID in: path description: Reason ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Reasons' text/json: schema: $ref: '#/components/schemas/Reasons' application/*+json: schema: $ref: '#/components/schemas/Reasons' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReasonsVBAResponse' application/json: schema: $ref: '#/components/schemas/ReasonsVBAResponse' text/json: schema: $ref: '#/components/schemas/ReasonsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reasons summary: Delete Reasons description: Deletes an Reasons operationId: DeleteReasons parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reasonID in: path description: Reason ID required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reasons-batch: put: tags: - Reasons summary: Create or Update Batch Reasons description: 'Create or Update multiple Reasons at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReasons parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Reasons' text/json: schema: type: array items: $ref: '#/components/schemas/Reasons' application/*+json: schema: type: array items: $ref: '#/components/schemas/Reasons' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/batches/{batchID}/claims/{claimID}/recalculate-auths': post: tags: - Auth Actions - Premium Claim summary: Recalculates Authorizations description: Recalculates all Authorizations for the specified Batch ID and Claim ID operationId: RecalculateAuths parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: batchID in: path description: Batch Id required: true schema: type: integer format: int32 - name: claimID in: path description: Claim Id required: true schema: type: integer format: int32 responses: '202': description: Accepted '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /reimburse-schedules: post: tags: - Reimburse Schedules summary: Create ReimburseSchedule description: Creates a new ReimburseSchedule operationId: CreateReimburseSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReimburseSchedule' text/json: schema: $ref: '#/components/schemas/ReimburseSchedule' application/*+json: schema: $ref: '#/components/schemas/ReimburseSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReimburseScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/ReimburseScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/ReimburseScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reimburse Schedules summary: List ReimburseSchedule description: Lists all ReimburseSchedule operationId: ListReimburseSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReimburseScheduleListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReimburseScheduleListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReimburseScheduleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reimburse-schedules/{reimburseSchedule}': get: tags: - Reimburse Schedules summary: Get ReimburseSchedule description: Gets ReimburseSchedule operationId: GetReimburseSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reimburseSchedule in: path description: Reimburse Schedule required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReimburseScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/ReimburseScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/ReimburseScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reimburse Schedules summary: Update ReimburseSchedule description: Updates a specific ReimburseSchedule. operationId: UpdateReimburseSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reimburseSchedule in: path description: Reimburse Schedule required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReimburseSchedule' text/json: schema: $ref: '#/components/schemas/ReimburseSchedule' application/*+json: schema: $ref: '#/components/schemas/ReimburseSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReimburseScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/ReimburseScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/ReimburseScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reimburse Schedules summary: Delete ReimburseSchedule description: Deletes an ReimburseSchedule operationId: DeleteReimburseSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reimburseSchedule in: path description: Reimburse Schedule required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reimburse-schedules-batch: put: tags: - Reimburse Schedules summary: Create or Update Batch ReimburseSchedule description: 'Create or Update multiple ReimburseSchedule at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReimburseSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReimburseSchedule' text/json: schema: type: array items: $ref: '#/components/schemas/ReimburseSchedule' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReimburseSchedule' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/accumulators': post: tags: - Reinsurance Accumulators summary: Create ReinsAccum description: Creates a new ReinsAccum operationId: CreateReinsAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsAccum' text/json: schema: $ref: '#/components/schemas/ReinsAccum' application/*+json: schema: $ref: '#/components/schemas/ReinsAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Accumulators summary: List ReinsAccum description: Lists all ReinsAccum for the given reinsContractKey operationId: ListReinsAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsAccumListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsAccumListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsAccumListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/accumulators/{subscriberID}/{memberSeq}/{claimNumber}': get: tags: - Reinsurance Accumulators summary: Get ReinsAccum description: Gets ReinsAccum operationId: GetReinsAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Accumulators summary: Update ReinsAccum description: Updates a specific ReinsAccum. operationId: UpdateReinsAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsAccum' text/json: schema: $ref: '#/components/schemas/ReinsAccum' application/*+json: schema: $ref: '#/components/schemas/ReinsAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Accumulators summary: Delete ReinsAccum description: Deletes an ReinsAccum operationId: DeleteReinsAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/accumulators-batch': put: tags: - Reinsurance Accumulators summary: Create or Update Batch ReinsAccum description: 'Create or Update multiple ReinsAccum at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsAccum' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsAccum' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsAccum' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contracts: post: tags: - Reinsurance Contracts summary: Create ReinsContract description: Creates a new ReinsContract operationId: CreateReinsContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContract' text/json: schema: $ref: '#/components/schemas/ReinsContract' application/*+json: schema: $ref: '#/components/schemas/ReinsContract' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contracts summary: List ReinsContract description: Lists all ReinsContract operationId: ListReinsContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contract-add-from-template: post: tags: - Reinsurance Contracts - Adv. Reinsurance summary: Add ReinsContract from a Template ReinsContract description: Take the information from a template and apply it to one or more new contracts based on that template contract. operationId: AddContractFromTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsServiceAddFromTemplate' text/json: schema: $ref: '#/components/schemas/ReinsServiceAddFromTemplate' application/*+json: schema: $ref: '#/components/schemas/ReinsServiceAddFromTemplate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contract-copy: post: tags: - Reinsurance Contracts - Adv. Reinsurance summary: Copy and existing ReinsContract to a new ReinsContract description: Copy everything from an existing contract to a new Contract. operationId: AddContractFromExisting parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsServiceAddFromExisting' text/json: schema: $ref: '#/components/schemas/ReinsServiceAddFromExisting' application/*+json: schema: $ref: '#/components/schemas/ReinsServiceAddFromExisting' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}': get: tags: - Reinsurance Contracts summary: Get ReinsContract description: Gets ReinsContract operationId: GetReinsContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contracts summary: Update ReinsContract description: Updates a specific ReinsContract. operationId: UpdateReinsContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContract' text/json: schema: $ref: '#/components/schemas/ReinsContract' application/*+json: schema: $ref: '#/components/schemas/ReinsContract' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contracts summary: Delete ReinsContract description: Deletes an ReinsContract operationId: DeleteReinsContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contracts-batch: put: tags: - Reinsurance Contracts summary: Create or Update Batch ReinsContract description: 'Create or Update multiple ReinsContract at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContract parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContract' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContract' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContract' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/generate-transaction': post: tags: - Reinsurance Contracts - Adv. Reinsurance summary: Generate Transactions for this Contract description: 'Based on submitted information, generate reinsurance transactions for this contract.' operationId: GenerateReinsTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: autoApplyDeductible in: query description: Auto Apply Deductible required: true schema: type: boolean - name: subscriberId in: query description: Subscriber ID schema: type: string - name: memberSeq in: query description: Member Sequence schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GenerateReinsTransactionVBAResponse' application/json: schema: $ref: '#/components/schemas/GenerateReinsTransactionVBAResponse' text/json: schema: $ref: '#/components/schemas/GenerateReinsTransactionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/generate-level-transaction': post: tags: - Reinsurance Contracts - Adv. Reinsurance summary: Generate Level Transactions for this Contract description: 'Based on submitted information, generate reinsurance level transactions for this contract.' operationId: GenerateReinsLevelTransaction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32VBAResponse' application/json: schema: $ref: '#/components/schemas/Int32VBAResponse' text/json: schema: $ref: '#/components/schemas/Int32VBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/aggregate-specific-members': post: tags: - Reinsurance Aggregating Specific Members summary: Create ReinsContractAggSpecMember description: Creates a new ReinsContractAggSpecMember operationId: CreateReinsContractAggSpecMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractAggSpecMember' text/json: schema: $ref: '#/components/schemas/ReinsContractAggSpecMember' application/*+json: schema: $ref: '#/components/schemas/ReinsContractAggSpecMember' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractAggSpecMemberVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractAggSpecMemberVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractAggSpecMemberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Aggregating Specific Members summary: List ReinsContractAggSpecMember description: Lists all ReinsContractAggSpecMember for the given reinsContractKey operationId: ListReinsContractAggSpecMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractAggSpecMemberListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractAggSpecMemberListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractAggSpecMemberListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/aggregate-specific-members/{subscriberID}/{memberSeq}': get: tags: - Reinsurance Aggregating Specific Members summary: Get ReinsContractAggSpecMember description: Gets ReinsContractAggSpecMember operationId: GetReinsContractAggSpecMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractAggSpecMemberVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractAggSpecMemberVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractAggSpecMemberVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Aggregating Specific Members summary: Delete ReinsContractAggSpecMember description: Deletes an ReinsContractAggSpecMember operationId: DeleteReinsContractAggSpecMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/aggregate-specific-members-batch': put: tags: - Reinsurance Aggregating Specific Members summary: Create Batch ReinsContractAggSpecMember description: 'Create multiple ReinsContractAggSpecMember at once. If the entity does not exist, it will be created. If the entity exists, an error message will be returned for this item.' operationId: UpdateBatchReinsContractAggSpecMember parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractAggSpecMember' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractAggSpecMember' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractAggSpecMember' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/conditional-specific': post: tags: - Reinsurance Conditional Specific summary: Create ReinsContractConditionalSpecific description: Creates a new ReinsContractConditionalSpecific operationId: CreateReinsContractConditionalSpecific parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecific' text/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecific' application/*+json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecific' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Conditional Specific summary: List ReinsContractConditionalSpecific description: Lists all ReinsContractConditionalSpecific for the given reinsContractKey operationId: ListReinsContractConditionalSpecific parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/conditional-specific/{reinsContractConditionalSpecificKey}': get: tags: - Reinsurance Conditional Specific summary: Get ReinsContractConditionalSpecific description: Gets ReinsContractConditionalSpecific operationId: GetReinsContractConditionalSpecific parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractConditionalSpecificKey in: path description: ReinsContractConditionalSpecific Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Conditional Specific summary: Update ReinsContractConditionalSpecific description: Updates a specific ReinsContractConditionalSpecific. operationId: UpdateReinsContractConditionalSpecific parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractConditionalSpecificKey in: path description: ReinsContractConditionalSpecific Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecific' text/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecific' application/*+json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecific' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Conditional Specific summary: Delete ReinsContractConditionalSpecific description: Deletes an ReinsContractConditionalSpecific operationId: DeleteReinsContractConditionalSpecific parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractConditionalSpecificKey in: path description: ReinsContractConditionalSpecific Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/conditional-specific-batch': put: tags: - Reinsurance Conditional Specific summary: Create or Update Batch ReinsContractConditionalSpecific description: 'Create or Update multiple ReinsContractConditionalSpecific at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractConditionalSpecific parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractConditionalSpecific' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractConditionalSpecific' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractConditionalSpecific' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contract-conditional-specifics/{reinsContractConditionalSpecificKey}/detail': post: tags: - Reinsurance Conditional Specific Detail summary: Create ReinsContractConditionalSpecificDetail description: Creates a new ReinsContractConditionalSpecificDetail operationId: CreateReinsContractConditionalSpecificDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractConditionalSpecificKey in: path description: ReinsContractConditionalSpecific Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetail' text/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetail' application/*+json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Conditional Specific Detail summary: List ReinsContractConditionalSpecificDetail description: Lists all ReinsContractConditionalSpecificDetail for the given reinsContractConditionalSpecificKey operationId: ListReinsContractConditionalSpecificDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractConditionalSpecificKey in: path description: ReinsContractConditionalSpecific Key required: true schema: type: integer format: int32 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contract-conditional-specifics/{reinsContractConditionalSpecificKey}/detail/{reinsContractConditionalSpecificDetailKey}': get: tags: - Reinsurance Conditional Specific Detail summary: Get ReinsContractConditionalSpecificDetail description: Gets ReinsContractConditionalSpecificDetail operationId: GetReinsContractConditionalSpecificDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractConditionalSpecificKey in: path description: ReinsContractConditionalSpecific Key required: true schema: type: integer format: int32 - name: reinsContractConditionalSpecificDetailKey in: path description: ReinsContractConditionalSpecificDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Conditional Specific Detail summary: Update ReinsContractConditionalSpecificDetail description: Updates a specific ReinsContractConditionalSpecificDetail. operationId: UpdateReinsContractConditionalSpecificDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractConditionalSpecificKey in: path description: ReinsContractConditionalSpecific Key required: true schema: type: integer format: int32 - name: reinsContractConditionalSpecificDetailKey in: path description: ReinsContractConditionalSpecificDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetail' text/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetail' application/*+json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Conditional Specific Detail summary: Delete ReinsContractConditionalSpecificDetail description: Deletes an ReinsContractConditionalSpecificDetail operationId: DeleteReinsContractConditionalSpecificDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractConditionalSpecificKey in: path description: ReinsContractConditionalSpecific Key required: true schema: type: integer format: int32 - name: reinsContractConditionalSpecificDetailKey in: path description: ReinsContractConditionalSpecificDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contract-conditional-specifics/{reinsContractConditionalSpecificKey}/detail-batch': put: tags: - Reinsurance Conditional Specific Detail summary: Create or Update Batch ReinsContractConditionalSpecificDetail description: 'Create or Update multiple ReinsContractConditionalSpecificDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractConditionalSpecificDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractConditionalSpecificKey in: path description: ReinsContractConditionalSpecific Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/criterias': post: tags: - Reinsurance Contract Criterias summary: Create ReinsContractCriteria description: Creates a new ReinsContractCriteria operationId: CreateReinsContractCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractCriteria' text/json: schema: $ref: '#/components/schemas/ReinsContractCriteria' application/*+json: schema: $ref: '#/components/schemas/ReinsContractCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Criterias summary: List ReinsContractCriteria description: Lists all ReinsContractCriteria for the given reinsContractKey operationId: ListReinsContractCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractCriteriaListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/criterias/{reinsContractCriteriaKey}': get: tags: - Reinsurance Contract Criterias summary: Get ReinsContractCriteria description: Gets ReinsContractCriteria operationId: GetReinsContractCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractCriteriaKey in: path description: ReinsContractCriteria Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Criterias summary: Update ReinsContractCriteria description: Updates a specific ReinsContractCriteria. operationId: UpdateReinsContractCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractCriteriaKey in: path description: ReinsContractCriteria Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractCriteria' text/json: schema: $ref: '#/components/schemas/ReinsContractCriteria' application/*+json: schema: $ref: '#/components/schemas/ReinsContractCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Criterias summary: Delete ReinsContractCriteria description: Deletes an ReinsContractCriteria operationId: DeleteReinsContractCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractCriteriaKey in: path description: ReinsContractCriteria Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/criterias-batch': put: tags: - Reinsurance Contract Criterias summary: Create or Update Batch ReinsContractCriteria description: 'Create or Update multiple ReinsContractCriteria at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractCriteria' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractCriteria' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractCriteria' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/criterias/{reinsContractCriteriaKey}/details': post: tags: - Reinsurance Contract Criteria Details summary: Create ReinsContractCriteriaDetail description: Creates a new ReinsContractCriteriaDetail operationId: CreateReinsContractCriteriaDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractCriteriaKey in: path description: ReinsContractCriteria Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetail' text/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetail' application/*+json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Criteria Details summary: List ReinsContractCriteriaDetail description: Lists all ReinsContractCriteriaDetail for the given reinsContractCriteriaKey operationId: ListReinsContractCriteriaDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractCriteriaKey in: path description: ReinsContractCriteria Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/criterias/{reinsContractCriteriaKey}/details/{reinsContractCriteriaDetailKey}': get: tags: - Reinsurance Contract Criteria Details summary: Get ReinsContractCriteriaDetail description: Gets ReinsContractCriteriaDetail operationId: GetReinsContractCriteriaDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractCriteriaKey in: path description: ReinsContractCriteria Key required: true schema: type: integer format: int32 - name: reinsContractCriteriaDetailKey in: path description: ReinsContractCriteriaDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Criteria Details summary: Update ReinsContractCriteriaDetail description: Updates a specific ReinsContractCriteriaDetail. operationId: UpdateReinsContractCriteriaDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractCriteriaKey in: path description: ReinsContractCriteria Key required: true schema: type: integer format: int32 - name: reinsContractCriteriaDetailKey in: path description: ReinsContractCriteriaDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetail' text/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetail' application/*+json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractCriteriaDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Criteria Details summary: Delete ReinsContractCriteriaDetail description: Deletes an ReinsContractCriteriaDetail operationId: DeleteReinsContractCriteriaDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractCriteriaKey in: path description: ReinsContractCriteria Key required: true schema: type: integer format: int32 - name: reinsContractCriteriaDetailKey in: path description: ReinsContractCriteriaDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/criterias/{reinsContractCriteriaKey}/details-batch': put: tags: - Reinsurance Contract Criteria Details summary: Create or Update Batch ReinsContractCriteriaDetail description: 'Create or Update multiple ReinsContractCriteriaDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractCriteriaDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractCriteriaKey in: path description: ReinsContractCriteria Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractCriteriaDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractCriteriaDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractCriteriaDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contract-cycles: post: tags: - Reinsurance Contract Cycles summary: Create ReinsContractCycle description: Creates a new ReinsContractCycle operationId: CreateReinsContractCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractCycle' text/json: schema: $ref: '#/components/schemas/ReinsContractCycle' application/*+json: schema: $ref: '#/components/schemas/ReinsContractCycle' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractCycleVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractCycleVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractCycleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Cycles summary: List ReinsContractCycle description: Lists all ReinsContractCycle operationId: ListReinsContractCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractCycleListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractCycleListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractCycleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contract-cycles/{contractCycle}': get: tags: - Reinsurance Contract Cycles summary: Get ReinsContractCycle description: Gets ReinsContractCycle operationId: GetReinsContractCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractCycle in: path description: Contract Cycle required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractCycleVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractCycleVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractCycleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Cycles summary: Update ReinsContractCycle description: Updates a specific ReinsContractCycle. operationId: UpdateReinsContractCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractCycle in: path description: Contract Cycle required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractCycle' text/json: schema: $ref: '#/components/schemas/ReinsContractCycle' application/*+json: schema: $ref: '#/components/schemas/ReinsContractCycle' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractCycleVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractCycleVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractCycleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Cycles summary: Delete ReinsContractCycle description: Deletes an ReinsContractCycle operationId: DeleteReinsContractCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractCycle in: path description: Contract Cycle required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contract-cycles-batch: put: tags: - Reinsurance Contract Cycles summary: Create or Update Batch ReinsContractCycle description: 'Create or Update multiple ReinsContractCycle at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractCycle parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractCycle' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractCycle' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractCycle' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/factors': post: tags: - Reinsurance Contract Factors summary: Create ReinsContractFactor description: Creates a new ReinsContractFactor operationId: CreateReinsContractFactor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractFactor' text/json: schema: $ref: '#/components/schemas/ReinsContractFactor' application/*+json: schema: $ref: '#/components/schemas/ReinsContractFactor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractFactorVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractFactorVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractFactorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Factors summary: List ReinsContractFactor description: Lists all ReinsContractFactor for the given reinsContractKey operationId: ListReinsContractFactor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractFactorListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractFactorListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractFactorListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/factors/{reinsContractFactorKey}': get: tags: - Reinsurance Contract Factors summary: Get ReinsContractFactor description: Gets ReinsContractFactor operationId: GetReinsContractFactor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractFactorKey in: path description: ReinsContractFactor Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractFactorVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractFactorVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractFactorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Factors summary: Update ReinsContractFactor description: Updates a specific ReinsContractFactor. operationId: UpdateReinsContractFactor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractFactorKey in: path description: ReinsContractFactor Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractFactor' text/json: schema: $ref: '#/components/schemas/ReinsContractFactor' application/*+json: schema: $ref: '#/components/schemas/ReinsContractFactor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractFactorVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractFactorVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractFactorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Factors summary: Delete ReinsContractFactor description: Deletes an ReinsContractFactor operationId: DeleteReinsContractFactor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractFactorKey in: path description: ReinsContractFactor Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/factors-batch': put: tags: - Reinsurance Contract Factors summary: Create or Update Batch ReinsContractFactor description: 'Create or Update multiple ReinsContractFactor at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractFactor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractFactor' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractFactor' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractFactor' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/factor-criterias': post: tags: - Reinsurance Contract Factor Criterias summary: Create ReinsContractFactorCriteria description: Creates a new ReinsContractFactorCriteria operationId: CreateReinsContractFactorCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteria' text/json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteria' application/*+json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractFactorCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Factor Criterias summary: List ReinsContractFactorCriteria description: Lists all ReinsContractFactorCriteria for the given reinsContractKey operationId: ListReinsContractFactorCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractFactorCriteriaListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteriaListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteriaListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/factor-criterias/{reinsContractFactorCriteriaKey}': get: tags: - Reinsurance Contract Factor Criterias summary: Get ReinsContractFactorCriteria description: Gets ReinsContractFactorCriteria operationId: GetReinsContractFactorCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractFactorCriteriaKey in: path description: ReinsContractFactorCriteria Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractFactorCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Factor Criterias summary: Update ReinsContractFactorCriteria description: Updates a specific ReinsContractFactorCriteria. operationId: UpdateReinsContractFactorCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractFactorCriteriaKey in: path description: ReinsContractFactorCriteria Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteria' text/json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteria' application/*+json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractFactorCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractFactorCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Factor Criterias summary: Delete ReinsContractFactorCriteria description: Deletes an ReinsContractFactorCriteria operationId: DeleteReinsContractFactorCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractFactorCriteriaKey in: path description: ReinsContractFactorCriteria Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/factor-criterias-batch': put: tags: - Reinsurance Contract Factor Criterias summary: Create or Update Batch ReinsContractFactorCriteria description: 'Create or Update multiple ReinsContractFactorCriteria at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractFactorCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractFactorCriteria' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractFactorCriteria' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractFactorCriteria' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/member-specific-deductibles': post: tags: - Reinsurance Member Specific Deductibles summary: Create ReinsContractMemberSpecific description: Creates a new ReinsContractMemberSpecific operationId: CreateReinsContractMemberSpecific parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecific' text/json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecific' application/*+json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecific' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractMemberSpecificVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecificVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecificVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Member Specific Deductibles summary: List ReinsContractMemberSpecific description: Lists all ReinsContractMemberSpecific for the given reinsContractKey operationId: ListReinsContractMemberSpecific parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractMemberSpecificListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecificListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecificListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/member-specific-deductibles/{subscriberID}/{memberSeq}': get: tags: - Reinsurance Member Specific Deductibles summary: Get ReinsContractMemberSpecific description: Gets ReinsContractMemberSpecific operationId: GetReinsContractMemberSpecific parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractMemberSpecificVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecificVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecificVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Member Specific Deductibles summary: Update ReinsContractMemberSpecific description: Updates a specific ReinsContractMemberSpecific. operationId: UpdateReinsContractMemberSpecific parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecific' text/json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecific' application/*+json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecific' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractMemberSpecificVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecificVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractMemberSpecificVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Member Specific Deductibles summary: Delete ReinsContractMemberSpecific description: Deletes an ReinsContractMemberSpecific operationId: DeleteReinsContractMemberSpecific parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: memberSeq in: path description: Member Seq required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/member-specific-deductibles-batch': put: tags: - Reinsurance Member Specific Deductibles summary: Create or Update Batch ReinsContractMemberSpecific description: 'Create or Update multiple ReinsContractMemberSpecific at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractMemberSpecific parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractMemberSpecific' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractMemberSpecific' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractMemberSpecific' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/notify-user-groups': post: tags: - Reinsurance Notify User Groups summary: Create ReinsContractNotifyGroup description: Creates a new ReinsContractNotifyGroup operationId: CreateReinsContractNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractNotifyGroup' text/json: schema: $ref: '#/components/schemas/ReinsContractNotifyGroup' application/*+json: schema: $ref: '#/components/schemas/ReinsContractNotifyGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractNotifyGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractNotifyGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractNotifyGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Notify User Groups summary: List ReinsContractNotifyGroup description: Lists all ReinsContractNotifyGroup for the given reinsContractKey operationId: ListReinsContractNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractNotifyGroupListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractNotifyGroupListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractNotifyGroupListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/notify-user-groups/{userGroupKey}': get: tags: - Reinsurance Notify User Groups summary: Get ReinsContractNotifyGroup description: Gets ReinsContractNotifyGroup operationId: GetReinsContractNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractNotifyGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractNotifyGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractNotifyGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Notify User Groups summary: Delete ReinsContractNotifyGroup description: Deletes an ReinsContractNotifyGroup operationId: DeleteReinsContractNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/notify-user-groups-batch': put: tags: - Reinsurance Notify User Groups summary: Create or Update Batch ReinsContractNotifyGroup description: 'Create or Update multiple ReinsContractNotifyGroup at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractNotifyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractNotifyGroup' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractNotifyGroup' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractNotifyGroup' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/notify-users': post: tags: - Reinsurance Notify Users summary: Create ReinsContractNotifyUser description: Creates a new ReinsContractNotifyUser operationId: CreateReinsContractNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractNotifyUser' text/json: schema: $ref: '#/components/schemas/ReinsContractNotifyUser' application/*+json: schema: $ref: '#/components/schemas/ReinsContractNotifyUser' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractNotifyUserVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractNotifyUserVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractNotifyUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Notify Users summary: List ReinsContractNotifyUser description: Lists all ReinsContractNotifyUser for the given reinsContractKey operationId: ListReinsContractNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractNotifyUserListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractNotifyUserListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractNotifyUserListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/notify-users/{userID}': get: tags: - Reinsurance Notify Users summary: Get ReinsContractNotifyUser description: Gets ReinsContractNotifyUser operationId: GetReinsContractNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractNotifyUserVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractNotifyUserVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractNotifyUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Notify Users summary: Delete ReinsContractNotifyUser description: Deletes an ReinsContractNotifyUser operationId: DeleteReinsContractNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/notify-users-batch': put: tags: - Reinsurance Notify Users summary: Create or Update Batch ReinsContractNotifyUser description: 'Create or Update multiple ReinsContractNotifyUser at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractNotifyUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractNotifyUser' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractNotifyUser' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractNotifyUser' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contract-statuses: post: tags: - Reinsurance Contract Status summary: Create ReinsContractStatus description: Creates a new ReinsContractStatus operationId: CreateReinsContractStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractStatus' text/json: schema: $ref: '#/components/schemas/ReinsContractStatus' application/*+json: schema: $ref: '#/components/schemas/ReinsContractStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Status summary: List ReinsContractStatus description: Lists all ReinsContractStatus operationId: ListReinsContractStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contract-statuses/{contractStatus}': get: tags: - Reinsurance Contract Status summary: Get ReinsContractStatus description: Gets ReinsContractStatus operationId: GetReinsContractStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractStatus in: path description: Contract Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Status summary: Update ReinsContractStatus description: Updates a specific ReinsContractStatus. operationId: UpdateReinsContractStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractStatus in: path description: Contract Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractStatus' text/json: schema: $ref: '#/components/schemas/ReinsContractStatus' application/*+json: schema: $ref: '#/components/schemas/ReinsContractStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Status summary: Delete ReinsContractStatus description: Deletes an ReinsContractStatus operationId: DeleteReinsContractStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractStatus in: path description: Contract Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contract-statuses-batch: put: tags: - Reinsurance Contract Status summary: Create or Update Batch ReinsContractStatus description: 'Create or Update multiple ReinsContractStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{contractKey}/templates': post: tags: - Reinsurance Contract Templates summary: Create ReinsContractTemplate description: Creates a new ReinsContractTemplate operationId: CreateReinsContractTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractKey in: path description: Contract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractTemplate' text/json: schema: $ref: '#/components/schemas/ReinsContractTemplate' application/*+json: schema: $ref: '#/components/schemas/ReinsContractTemplate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTemplateVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTemplateVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTemplateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Templates summary: List ReinsContractTemplate description: Lists all ReinsContractTemplate for the given contractKey operationId: ListReinsContractTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractKey in: path description: Contract Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTemplateListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTemplateListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTemplateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{contractKey}/templates/{templateContractKey}': get: tags: - Reinsurance Contract Templates summary: Get ReinsContractTemplate description: Gets ReinsContractTemplate operationId: GetReinsContractTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractKey in: path description: Contract Key required: true schema: type: integer format: int32 - name: templateContractKey in: path description: TemplateContract Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTemplateVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTemplateVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTemplateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Templates summary: Delete ReinsContractTemplate description: Deletes an ReinsContractTemplate operationId: DeleteReinsContractTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractKey in: path description: Contract Key required: true schema: type: integer format: int32 - name: templateContractKey in: path description: TemplateContract Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{contractKey}/templates-batch': put: tags: - Reinsurance Contract Templates summary: Create Batch ReinsContractTemplate description: 'Create multiple ReinsContractTemplate at once. If the entity exists, an error message will be returned for the item. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractKey in: path description: Contract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTemplate' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTemplate' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTemplate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions': post: tags: - Reinsurance Contract Transactions summary: Create ReinsContractTrans description: Creates a new ReinsContractTrans operationId: CreateReinsContractTrans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractTrans' text/json: schema: $ref: '#/components/schemas/ReinsContractTrans' application/*+json: schema: $ref: '#/components/schemas/ReinsContractTrans' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Transactions summary: List ReinsContractTrans description: Lists all ReinsContractTrans for the given reinsContractKey operationId: ListReinsContractTrans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions-summary': get: tags: - Reinsurance Contract Transactions summary: List ReinsContractTrans description: Lists all ReinsContractTransactions in a Summary for the given reinsContractKey operationId: List_VBA_ReinsContractTransactionSummary parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_ReinsContractTransactionSummaryListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_ReinsContractTransactionSummaryListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_ReinsContractTransactionSummaryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/claim-info': get: tags: - Reinsurance Contract Transactions summary: List ReinsContractTransClaim Info description: List all Claims attached to this Reinsurance Transaction along with some associated claim information and amount summaries. operationId: List_VBA_ReinsContractTransClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_ReinsContractTransClaimListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_ReinsContractTransClaimListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_ReinsContractTransClaimListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/reimburse-info': get: tags: - Reinsurance Contract Transactions summary: List Calculated ReinsContractTransClaim description: List all Reimbursements attached to this Reinsurance Transaction along with some associated funding information and amount summaries. operationId: List_VBA_ReinsContractTransReimburse parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_ReinsContractTransReimburseListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_ReinsContractTransReimburseListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_ReinsContractTransReimburseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}': get: tags: - Reinsurance Contract Transactions summary: Get ReinsContractTrans description: Gets ReinsContractTrans operationId: GetReinsContractTrans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Transactions summary: Update ReinsContractTrans description: Updates a specific ReinsContractTrans. operationId: UpdateReinsContractTrans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractTrans' text/json: schema: $ref: '#/components/schemas/ReinsContractTrans' application/*+json: schema: $ref: '#/components/schemas/ReinsContractTrans' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Transactions summary: Delete ReinsContractTrans description: Deletes an ReinsContractTrans operationId: DeleteReinsContractTrans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions-batch': put: tags: - Reinsurance Contract Transactions summary: Create or Update Batch ReinsContractTrans description: 'Create or Update multiple ReinsContractTrans at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractTrans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTrans' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTrans' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTrans' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/calculate': post: tags: - Reinsurance Contract Transactions - Adv. Reinsurance summary: Calculate ReinsContractTrans description: 'Based on information existing in the ReinsTrans records and the attached ReinsTransClaim records, calculate the header information and return result.' operationId: CalculateReinsContractTrans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_ReinsContractTransAmountVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_ReinsContractTransAmountVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_ReinsContractTransAmountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/reset': post: tags: - Reinsurance Contract Transactions - Adv. Reinsurance summary: Reset ReinsContractTrans description: 'For all claims attached to this Reinsurance Transaction, reset the various applied amounts (Reimbursed, Not Covered, etc.).' operationId: ResetReinsContractTrans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/apply-deductible': post: tags: - Reinsurance Contract Transactions - Adv. Reinsurance summary: Apply Deductible ReinsContractTrans description: This option will reset all deductible applied amounts for claims on this transaction. Specific or Lasered Deductible amount is then applied to claims in service date order until deductible is met. operationId: ApplyDedReinsContractTrans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/apply-agg-spec-deductible': post: tags: - Reinsurance Contract Transactions - Adv. Reinsurance summary: Apply Agg. Spec. Deductible ReinsContractTrans description: Using this option will reset all aggregate deductible applied amounts for claims on this transaction. Aggregate Deductible amount is then applied to claims in service date order until Aggregate Specific Deductible is met. operationId: ApplyAggSpecDedReinsContractTrans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/apply-reimbursement': post: tags: - Reinsurance Contract Transactions - Adv. Reinsurance summary: Apply Reimbursement ReinsContractTrans description: Using this option will reset all reimbursement applied amounts for claims on this transaction. Received Reimbursement amount is then applied to claims in service date order until reimbursement amount is used. operationId: ApplyReimbursementReinsContractTrans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/claims': post: tags: - Reinsurance Contract Transaction Claims summary: Create ReinsContractTransClaim description: Creates a new ReinsContractTransClaim operationId: CreateReinsContractTransClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaim' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaim' application/*+json: schema: $ref: '#/components/schemas/ReinsContractTransClaim' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Transaction Claims summary: List ReinsContractTransClaim description: Lists all ReinsContractTransClaim for the given reinsContractTransKey operationId: ListReinsContractTransClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransClaimListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/claims/{claimNumber}': get: tags: - Reinsurance Contract Transaction Claims summary: Get ReinsContractTransClaim description: Gets ReinsContractTransClaim operationId: GetReinsContractTransClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Transaction Claims summary: Update ReinsContractTransClaim description: Updates a specific ReinsContractTransClaim. operationId: UpdateReinsContractTransClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaim' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaim' application/*+json: schema: $ref: '#/components/schemas/ReinsContractTransClaim' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Transaction Claims summary: Delete ReinsContractTransClaim description: Deletes an ReinsContractTransClaim operationId: DeleteReinsContractTransClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/claims-batch': put: tags: - Reinsurance Contract Transaction Claims summary: Create or Update Batch ReinsContractTransClaim description: 'Create or Update multiple ReinsContractTransClaim at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractTransClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransClaim' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransClaim' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransClaim' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/claims/{claimNumber}/details': post: tags: - Reinsurance Contract Transaction Claim Details summary: Create ReinsContractTransClaimDetail description: Creates a new ReinsContractTransClaimDetail operationId: CreateReinsContractTransClaimDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetail' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetail' application/*+json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Transaction Claim Details summary: List ReinsContractTransClaimDetail description: Lists all ReinsContractTransClaimDetail for the given reinsContractTransKey and claimNumber operationId: ListReinsContractTransClaimDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/claims/{claimNumber}/details/{reinsContractTransClaimDetailKey}': get: tags: - Reinsurance Contract Transaction Claim Details summary: Get ReinsContractTransClaimDetail description: Gets ReinsContractTransClaimDetail operationId: GetReinsContractTransClaimDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 - name: reinsContractTransClaimDetailKey in: path description: ReinsContractTransClaimDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Transaction Claim Details summary: Update ReinsContractTransClaimDetail description: Updates a specific ReinsContractTransClaimDetail. operationId: UpdateReinsContractTransClaimDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 - name: reinsContractTransClaimDetailKey in: path description: ReinsContractTransClaimDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetail' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetail' application/*+json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Transaction Claim Details summary: Delete ReinsContractTransClaimDetail description: Deletes an ReinsContractTransClaimDetail operationId: DeleteReinsContractTransClaimDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 - name: reinsContractTransClaimDetailKey in: path description: ReinsContractTransClaimDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/claims/{claimNumber}/details-batch': put: tags: - Reinsurance Contract Transaction Claim Details summary: Create or Update Batch ReinsContractTransClaimDetail description: 'Create or Update multiple ReinsContractTransClaimDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractTransClaimDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: claimNumber in: path description: Claim Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransClaimDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransClaimDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransClaimDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contracts-transaction-claim-statuses: post: tags: - Reinsurance Contract Transaction Claim Statuses summary: Create ReinsContractTransClaimStatus description: Creates a new ReinsContractTransClaimStatus operationId: CreateReinsContractTransClaimStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatus' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatus' application/*+json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Transaction Claim Statuses summary: List ReinsContractTransClaimStatus description: Lists all ReinsContractTransClaimStatus operationId: ListReinsContractTransClaimStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts-transaction-claim-statuses/{claimTransactionStatus}': get: tags: - Reinsurance Contract Transaction Claim Statuses summary: Get ReinsContractTransClaimStatus description: Gets ReinsContractTransClaimStatus operationId: GetReinsContractTransClaimStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimTransactionStatus in: path description: ClaimTransaction Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Transaction Claim Statuses summary: Update ReinsContractTransClaimStatus description: Updates a specific ReinsContractTransClaimStatus. operationId: UpdateReinsContractTransClaimStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimTransactionStatus in: path description: ClaimTransaction Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatus' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatus' application/*+json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransClaimStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Transaction Claim Statuses summary: Delete ReinsContractTransClaimStatus description: Deletes an ReinsContractTransClaimStatus operationId: DeleteReinsContractTransClaimStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: claimTransactionStatus in: path description: ClaimTransaction Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contracts-transaction-claim-statuses-batch: put: tags: - Reinsurance Contract Transaction Claim Statuses summary: Create or Update Batch ReinsContractTransClaimStatus description: 'Create or Update multiple ReinsContractTransClaimStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractTransClaimStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransClaimStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransClaimStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransClaimStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/reimbursements': post: tags: - Reinsurance Contract Transaction Reimbursements summary: Create ReinsContractTransReimburse description: Creates a new ReinsContractTransReimburse operationId: CreateReinsContractTransReimburse parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractTransReimburse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransReimburse' application/*+json: schema: $ref: '#/components/schemas/ReinsContractTransReimburse' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransReimburseVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransReimburseVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransReimburseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Transaction Reimbursements summary: List ReinsContractTransReimburse description: Lists all ReinsContractTransReimburse for the given reinsContractTransKey operationId: ListReinsContractTransReimburse parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransReimburseListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransReimburseListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransReimburseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/reimbursements/{reinsContractTransReimburseKey}': get: tags: - Reinsurance Contract Transaction Reimbursements summary: Get ReinsContractTransReimburse description: Gets ReinsContractTransReimburse operationId: GetReinsContractTransReimburse parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: reinsContractTransReimburseKey in: path description: ReinsContractTransReimburse Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransReimburseVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransReimburseVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransReimburseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Transaction Reimbursements summary: Update ReinsContractTransReimburse description: Updates a specific ReinsContractTransReimburse. operationId: UpdateReinsContractTransReimburse parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: reinsContractTransReimburseKey in: path description: ReinsContractTransReimburse Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractTransReimburse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransReimburse' application/*+json: schema: $ref: '#/components/schemas/ReinsContractTransReimburse' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransReimburseVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransReimburseVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransReimburseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Transaction Reimbursements summary: Delete ReinsContractTransReimburse description: Deletes an ReinsContractTransReimburse operationId: DeleteReinsContractTransReimburse parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 - name: reinsContractTransReimburseKey in: path description: ReinsContractTransReimburse Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/reimbursements-batch': put: tags: - Reinsurance Contract Transaction Reimbursements summary: Create or Update Batch ReinsContractTransReimburse description: 'Create or Update multiple ReinsContractTransReimburse at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractTransReimburse parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsContractTransKey in: path description: ReinsContractTrans Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransReimburse' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransReimburse' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransReimburse' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contracts-transaction-statuses: post: tags: - Reinsurance Contract Transaction Statuses summary: Create ReinsContractTransStatus description: Creates a new ReinsContractTransStatus operationId: CreateReinsContractTransStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractTransStatus' text/json: schema: $ref: '#/components/schemas/ReinsContractTransStatus' application/*+json: schema: $ref: '#/components/schemas/ReinsContractTransStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Transaction Statuses summary: List ReinsContractTransStatus description: Lists all ReinsContractTransStatus operationId: ListReinsContractTransStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts-transaction-statuses/{transactionStatus}': get: tags: - Reinsurance Contract Transaction Statuses summary: Get ReinsContractTransStatus description: Gets ReinsContractTransStatus operationId: GetReinsContractTransStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: transactionStatus in: path description: Transaction Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Transaction Statuses summary: Update ReinsContractTransStatus description: Updates a specific ReinsContractTransStatus. operationId: UpdateReinsContractTransStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: transactionStatus in: path description: Transaction Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractTransStatus' text/json: schema: $ref: '#/components/schemas/ReinsContractTransStatus' application/*+json: schema: $ref: '#/components/schemas/ReinsContractTransStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTransStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTransStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTransStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Transaction Statuses summary: Delete ReinsContractTransStatus description: Deletes an ReinsContractTransStatus operationId: DeleteReinsContractTransStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: transactionStatus in: path description: Transaction Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contracts-transaction-statuses-batch: put: tags: - Reinsurance Contract Transaction Statuses summary: Create or Update Batch ReinsContractTransStatus description: 'Create or Update multiple ReinsContractTransStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractTransStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractTransStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contract-types: post: tags: - Reinsurance Contract Types summary: Create ReinsContractType description: Creates a new ReinsContractType operationId: CreateReinsContractType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractType' text/json: schema: $ref: '#/components/schemas/ReinsContractType' application/*+json: schema: $ref: '#/components/schemas/ReinsContractType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Types summary: List ReinsContractType description: Lists all ReinsContractType operationId: ListReinsContractType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contract-types/{contractType}': get: tags: - Reinsurance Contract Types summary: Get ReinsContractType description: Gets ReinsContractType operationId: GetReinsContractType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractType in: path description: Contract Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Types summary: Update ReinsContractType description: Updates a specific ReinsContractType. operationId: UpdateReinsContractType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractType in: path description: Contract Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsContractType' text/json: schema: $ref: '#/components/schemas/ReinsContractType' application/*+json: schema: $ref: '#/components/schemas/ReinsContractType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsContractTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsContractTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsContractTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Types summary: Delete ReinsContractType description: Deletes an ReinsContractType operationId: DeleteReinsContractType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: contractType in: path description: Contract Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-contract-types-batch: put: tags: - Reinsurance Contract Types summary: Create or Update Batch ReinsContractType description: 'Create or Update multiple ReinsContractType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsContractType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractType' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsContractType' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsContractType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/domestic-claim-criterias': post: tags: - Reinsurance Domestic Claims Criteria summary: Create ReinsDomesticClaimCriteria description: Creates a new ReinsDomesticClaimCriteria operationId: CreateReinsDomesticClaimCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteria' text/json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteria' application/*+json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Domestic Claims Criteria summary: List ReinsDomesticClaimCriteria description: Lists all ReinsDomesticClaimCriteria for the given reinsContractKey operationId: ListReinsDomesticClaimCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteriaListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteriaListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteriaListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/domestic-claim-criterias/{reinsDomesticClaimCriteriaKey}': get: tags: - Reinsurance Domestic Claims Criteria summary: Get ReinsDomesticClaimCriteria description: Gets ReinsDomesticClaimCriteria operationId: GetReinsDomesticClaimCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsDomesticClaimCriteriaKey in: path description: ReinsDomesticClaimCriteria Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Domestic Claims Criteria summary: Update ReinsDomesticClaimCriteria description: Updates a specific ReinsDomesticClaimCriteria. operationId: UpdateReinsDomesticClaimCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsDomesticClaimCriteriaKey in: path description: ReinsDomesticClaimCriteria Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteria' text/json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteria' application/*+json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsDomesticClaimCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Domestic Claims Criteria summary: Delete ReinsDomesticClaimCriteria description: Deletes an ReinsDomesticClaimCriteria operationId: DeleteReinsDomesticClaimCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsDomesticClaimCriteriaKey in: path description: ReinsDomesticClaimCriteria Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/domestic-claim-criterias-batch': put: tags: - Reinsurance Domestic Claims Criteria summary: Create or Update Batch ReinsDomesticClaimCriteria description: 'Create or Update multiple ReinsDomesticClaimCriteria at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsDomesticClaimCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsDomesticClaimCriteria' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsDomesticClaimCriteria' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsDomesticClaimCriteria' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/levels': post: tags: - Reinsurance Contract Levels summary: Create ReinsLevel description: Creates a new ReinsLevel operationId: CreateReinsLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsLevel' text/json: schema: $ref: '#/components/schemas/ReinsLevel' application/*+json: schema: $ref: '#/components/schemas/ReinsLevel' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsLevelVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsLevelVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsLevelVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Contract Levels summary: List ReinsLevel description: Lists all ReinsLevel for the given reinsContractKey operationId: ListReinsLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsLevelListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsLevelListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsLevelListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/generate-reins-level': post: tags: - Reinsurance Contract Levels summary: Generate ReinsLevel Transactions description: Creates new Reinsurance Transactions based on Reinsurance Level configurations. operationId: GenerateReinsLevelTrans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/Int32VBAResponse' application/json: schema: $ref: '#/components/schemas/Int32VBAResponse' text/json: schema: $ref: '#/components/schemas/Int32VBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/levels/{reinsLevelSeq}': get: tags: - Reinsurance Contract Levels summary: Get ReinsLevel description: Gets ReinsLevel operationId: GetReinsLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsLevelSeq in: path description: ReinsLevel Seq required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsLevelVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsLevelVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsLevelVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reinsurance Contract Levels summary: Update ReinsLevel description: Updates a specific ReinsLevel. operationId: UpdateReinsLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsLevelSeq in: path description: ReinsLevel Seq required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsLevel' text/json: schema: $ref: '#/components/schemas/ReinsLevel' application/*+json: schema: $ref: '#/components/schemas/ReinsLevel' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsLevelVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsLevelVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsLevelVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Contract Levels summary: Delete ReinsLevel description: Deletes an ReinsLevel operationId: DeleteReinsLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 - name: reinsLevelSeq in: path description: ReinsLevel Seq required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-contracts/{reinsContractKey}/levels-batch': put: tags: - Reinsurance Contract Levels summary: Create or Update Batch ReinsLevel description: 'Create or Update multiple ReinsLevel at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsContractKey in: path description: ReinsContract Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsLevel' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsLevel' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsLevel' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-options: post: tags: - Reinsurance Options summary: Create ReinsuranceOption description: Creates a new ReinsuranceOption operationId: CreateReinsuranceOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinsuranceOption' text/json: schema: $ref: '#/components/schemas/ReinsuranceOption' application/*+json: schema: $ref: '#/components/schemas/ReinsuranceOption' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsuranceOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsuranceOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsuranceOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reinsurance Options summary: List ReinsuranceOption description: Lists all ReinsuranceOption operationId: ListReinsuranceOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsuranceOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsuranceOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsuranceOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/reinsurance-options/{reinsuranceOption}': get: tags: - Reinsurance Options summary: Get ReinsuranceOption description: Gets ReinsuranceOption operationId: GetReinsuranceOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsuranceOption in: path description: Reinsurance Option required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReinsuranceOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/ReinsuranceOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/ReinsuranceOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reinsurance Options summary: Delete ReinsuranceOption description: Deletes an ReinsuranceOption operationId: DeleteReinsuranceOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reinsuranceOption in: path description: Reinsurance Option required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reinsurance-options-batch: put: tags: - Reinsurance Options summary: Create Batch ReinsuranceOption description: 'Create multiple ReinsuranceOption at once. If the entity exists, an error will be returned. If the entity does not exist, it will be created.' operationId: UpdateBatchReinsuranceOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReinsuranceOption' text/json: schema: type: array items: $ref: '#/components/schemas/ReinsuranceOption' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReinsuranceOption' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /relationships: post: tags: - Relationships summary: Create Relationships description: Creates a new Relationships operationId: CreateRelationships parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Relationships' text/json: schema: $ref: '#/components/schemas/Relationships' application/*+json: schema: $ref: '#/components/schemas/Relationships' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/RelationshipsVBAResponse' application/json: schema: $ref: '#/components/schemas/RelationshipsVBAResponse' text/json: schema: $ref: '#/components/schemas/RelationshipsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Relationships summary: List Relationships description: 'Lists all Relationships ' operationId: ListRelationships parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/RelationshipsListVBAResponse' application/json: schema: $ref: '#/components/schemas/RelationshipsListVBAResponse' text/json: schema: $ref: '#/components/schemas/RelationshipsListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/relationships/{relateCode}': get: tags: - Relationships summary: Get Relationships description: Gets Relationships operationId: GetRelationships parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: relateCode in: path description: Relate Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/RelationshipsVBAResponse' application/json: schema: $ref: '#/components/schemas/RelationshipsVBAResponse' text/json: schema: $ref: '#/components/schemas/RelationshipsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Relationships summary: Update Relationships description: Updates a specific Relationships. operationId: UpdateRelationships parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: relateCode in: path description: Relate Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Relationships' text/json: schema: $ref: '#/components/schemas/Relationships' application/*+json: schema: $ref: '#/components/schemas/Relationships' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/RelationshipsVBAResponse' application/json: schema: $ref: '#/components/schemas/RelationshipsVBAResponse' text/json: schema: $ref: '#/components/schemas/RelationshipsVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Relationships summary: Delete Relationships description: Deletes an Relationships operationId: DeleteRelationships parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: relateCode in: path description: Relate Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /relationships-batch: put: tags: - Relationships summary: Create or Update Batch Relationships description: 'Create or Update multiple Relationships at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchRelationships parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Relationships' text/json: schema: type: array items: $ref: '#/components/schemas/Relationships' application/*+json: schema: type: array items: $ref: '#/components/schemas/Relationships' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-categories: post: tags: - Report Categories summary: Create ReportCategory description: Creates a new ReportCategory operationId: CreateReportCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportCategory' text/json: schema: $ref: '#/components/schemas/ReportCategory' application/*+json: schema: $ref: '#/components/schemas/ReportCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Categories summary: List ReportCategory description: Lists all ReportCategory operationId: ListReportCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportCategoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportCategoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportCategoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-categories/{reportCategory}': get: tags: - Report Categories summary: Get ReportCategory description: Gets ReportCategory operationId: GetReportCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportCategory in: path description: Report Category required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Categories summary: Update ReportCategory description: Updates a specific ReportCategory. operationId: UpdateReportCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportCategory in: path description: Report Category required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportCategory' text/json: schema: $ref: '#/components/schemas/ReportCategory' application/*+json: schema: $ref: '#/components/schemas/ReportCategory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportCategoryVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportCategoryVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportCategoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Categories summary: Delete ReportCategory description: Deletes an ReportCategory operationId: DeleteReportCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportCategory in: path description: Report Category required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-categories-batch: put: tags: - Report Categories summary: Create or Update Batch ReportCategory description: 'Create or Update multiple ReportCategory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportCategory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportCategory' text/json: schema: type: array items: $ref: '#/components/schemas/ReportCategory' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportCategory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-definitions: post: tags: - Report Definitions summary: Create ReportDefinition description: Creates a new ReportDefinition operationId: CreateReportDefinition parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportDefinition' text/json: schema: $ref: '#/components/schemas/ReportDefinition' application/*+json: schema: $ref: '#/components/schemas/ReportDefinition' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportDefinitionVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportDefinitionVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportDefinitionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Definitions summary: List ReportDefinition description: Lists all ReportDefinition operationId: ListReportDefinition parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: criteriaObject in: query description: Criteria Object schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportDefinitionListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportDefinitionListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportDefinitionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}': get: tags: - Report Definitions summary: Get ReportDefinition description: Gets ReportDefinition operationId: GetReportDefinition parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportDefinitionVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportDefinitionVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportDefinitionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Definitions summary: Update ReportDefinition description: Updates a specific ReportDefinition. operationId: UpdateReportDefinition parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportDefinition' text/json: schema: $ref: '#/components/schemas/ReportDefinition' application/*+json: schema: $ref: '#/components/schemas/ReportDefinition' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportDefinitionVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportDefinitionVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportDefinitionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Definitions summary: Delete ReportDefinition description: Deletes an ReportDefinition operationId: DeleteReportDefinition parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-definitions-batch: put: tags: - Report Definitions summary: Create or Update Batch ReportDefinition description: 'Create or Update multiple ReportDefinition at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportDefinition parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportDefinition' text/json: schema: type: array items: $ref: '#/components/schemas/ReportDefinition' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportDefinition' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-queues: post: tags: - Report Queues summary: Create ReportQueue description: Creates a new ReportQueue operationId: CreateReportQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportQueue' text/json: schema: $ref: '#/components/schemas/ReportQueue' application/*+json: schema: $ref: '#/components/schemas/ReportQueue' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Queues summary: List ReportQueue description: Lists all ReportQueue operationId: ListReportQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-queues/{reportQueueKey}': get: tags: - Report Queues summary: Get ReportQueue description: Gets ReportQueue operationId: GetReportQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueKey in: path description: ReportQueue Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Queues summary: Update ReportQueue description: Updates a specific ReportQueue. operationId: UpdateReportQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueKey in: path description: ReportQueue Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportQueue' text/json: schema: $ref: '#/components/schemas/ReportQueue' application/*+json: schema: $ref: '#/components/schemas/ReportQueue' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Queues summary: Delete ReportQueue description: Deletes an ReportQueue operationId: DeleteReportQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueKey in: path description: ReportQueue Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-queues-batch: put: tags: - Report Queues summary: Create or Update Batch ReportQueue description: 'Create or Update multiple ReportQueue at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportQueue parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportQueue' text/json: schema: type: array items: $ref: '#/components/schemas/ReportQueue' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportQueue' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-queues/{reportQueueKey}/details': post: tags: - Report Queue Details summary: Create ReportQueueDetail description: Creates a new ReportQueueDetail operationId: CreateReportQueueDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueKey in: path description: ReportQueue Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportQueueDetail' text/json: schema: $ref: '#/components/schemas/ReportQueueDetail' application/*+json: schema: $ref: '#/components/schemas/ReportQueueDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Queue Details summary: List ReportQueueDetail description: Lists all ReportQueueDetail for the given reportQueueKey operationId: ListReportQueueDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueKey in: path description: ReportQueue Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-queues/{reportQueueKey}/details/{reportQueueDetailKey}': get: tags: - Report Queue Details summary: Get ReportQueueDetail description: Gets ReportQueueDetail operationId: GetReportQueueDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueKey in: path description: ReportQueue Key required: true schema: type: integer format: int32 - name: reportQueueDetailKey in: path description: ReportQueueDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Queue Details summary: Update ReportQueueDetail description: Updates a specific ReportQueueDetail. operationId: UpdateReportQueueDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueKey in: path description: ReportQueue Key required: true schema: type: integer format: int32 - name: reportQueueDetailKey in: path description: ReportQueueDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportQueueDetail' text/json: schema: $ref: '#/components/schemas/ReportQueueDetail' application/*+json: schema: $ref: '#/components/schemas/ReportQueueDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Queue Details summary: Delete ReportQueueDetail description: Deletes an ReportQueueDetail operationId: DeleteReportQueueDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueKey in: path description: ReportQueue Key required: true schema: type: integer format: int32 - name: reportQueueDetailKey in: path description: ReportQueueDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-queues/{reportQueueKey}/details-batch': put: tags: - Report Queue Details summary: Create or Update Batch ReportQueueDetail description: 'Create or Update multiple ReportQueueDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportQueueDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueKey in: path description: ReportQueue Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportQueueDetail' text/json: schema: type: array items: $ref: '#/components/schemas/ReportQueueDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportQueueDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-queue-detail-args: post: tags: - Report Queue Detail Arguments summary: Create ReportQueueDetailArg description: Creates a new ReportQueueDetailArg operationId: CreateReportQueueDetailArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportQueueDetailArg' text/json: schema: $ref: '#/components/schemas/ReportQueueDetailArg' application/*+json: schema: $ref: '#/components/schemas/ReportQueueDetailArg' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueDetailArgVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueDetailArgVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueDetailArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Queue Detail Arguments summary: List ReportQueueDetailArg description: Lists all ReportQueueDetailArg operationId: ListReportQueueDetailArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueDetailKey in: query description: Filter by ReportQueueDetailKey schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueDetailArgListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueDetailArgListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueDetailArgListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-queue-detail-args/{reportQueueDetailArgKey}': get: tags: - Report Queue Detail Arguments summary: Get ReportQueueDetailArg description: Gets ReportQueueDetailArg operationId: GetReportQueueDetailArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueDetailArgKey in: path description: ReportQueueDetailArg Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueDetailArgVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueDetailArgVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueDetailArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Queue Detail Arguments summary: Update ReportQueueDetailArg description: Updates a specific ReportQueueDetailArg. operationId: UpdateReportQueueDetailArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueDetailArgKey in: path description: ReportQueueDetailArg Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportQueueDetailArg' text/json: schema: $ref: '#/components/schemas/ReportQueueDetailArg' application/*+json: schema: $ref: '#/components/schemas/ReportQueueDetailArg' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueDetailArgVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueDetailArgVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueDetailArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Queue Detail Arguments summary: Delete ReportQueueDetailArg description: Deletes an ReportQueueDetailArg operationId: DeleteReportQueueDetailArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueDetailArgKey in: path description: ReportQueueDetailArg Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-queue-detail-args-batch: put: tags: - Report Queue Detail Arguments summary: Create or Update Batch ReportQueueDetailArg description: 'Create or Update multiple ReportQueueDetailArg at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportQueueDetailArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportQueueDetailArg' text/json: schema: type: array items: $ref: '#/components/schemas/ReportQueueDetailArg' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportQueueDetailArg' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-queue-logs: post: tags: - Report Queue Logs summary: Create ReportQueueLog description: Creates a new ReportQueueLog operationId: CreateReportQueueLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportQueueLog' text/json: schema: $ref: '#/components/schemas/ReportQueueLog' application/*+json: schema: $ref: '#/components/schemas/ReportQueueLog' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueLogVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueLogVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Queue Logs summary: List ReportQueueLog description: Lists all ReportQueueLog operationId: ListReportQueueLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueDetailKey in: query description: 'Filter by ReportQueueDetail_Key ' schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueLogListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueLogListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueLogListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-queue-logs/{reportQueueLogKey}': get: tags: - Report Queue Logs summary: Get ReportQueueLog description: Gets ReportQueueLog operationId: GetReportQueueLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueLogKey in: path description: ReportQueueLog Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueLogVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueLogVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Queue Logs summary: Update ReportQueueLog description: Updates a specific ReportQueueLog. operationId: UpdateReportQueueLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueLogKey in: path description: ReportQueueLog Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportQueueLog' text/json: schema: $ref: '#/components/schemas/ReportQueueLog' application/*+json: schema: $ref: '#/components/schemas/ReportQueueLog' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueLogVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueLogVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Queue Logs summary: Delete ReportQueueLog description: Deletes an ReportQueueLog operationId: DeleteReportQueueLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueLogKey in: path description: ReportQueueLog Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-queue-logs-batch: put: tags: - Report Queue Logs summary: Create or Update Batch ReportQueueLog description: 'Create or Update multiple ReportQueueLog at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportQueueLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportQueueLog' text/json: schema: type: array items: $ref: '#/components/schemas/ReportQueueLog' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportQueueLog' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-queue-schedules: post: tags: - Report Queue Schedules summary: Create ReportQueueSchedule description: Creates a new ReportQueueSchedule operationId: CreateReportQueueSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportQueueSchedule' text/json: schema: $ref: '#/components/schemas/ReportQueueSchedule' application/*+json: schema: $ref: '#/components/schemas/ReportQueueSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Queue Schedules summary: List ReportQueueSchedule description: Lists all ReportQueueSchedule operationId: ListReportQueueSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueKey in: query description: Filter by ReportQueue_Key schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueScheduleListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueScheduleListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueScheduleListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-queue-schedules/{reportQueueScheduleKey}': get: tags: - Report Queue Schedules summary: Get ReportQueueSchedule description: Gets ReportQueueSchedule operationId: GetReportQueueSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueScheduleKey in: path description: ReportQueueSchedule Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Queue Schedules summary: Update ReportQueueSchedule description: Updates a specific ReportQueueSchedule. operationId: UpdateReportQueueSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueScheduleKey in: path description: ReportQueueSchedule Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportQueueSchedule' text/json: schema: $ref: '#/components/schemas/ReportQueueSchedule' application/*+json: schema: $ref: '#/components/schemas/ReportQueueSchedule' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportQueueScheduleVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportQueueScheduleVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportQueueScheduleVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Queue Schedules summary: Delete ReportQueueSchedule description: Deletes an ReportQueueSchedule operationId: DeleteReportQueueSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportQueueScheduleKey in: path description: ReportQueueSchedule Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-queue-schedules-batch: put: tags: - Report Queue Schedules summary: Create or Update Batch ReportQueueSchedule description: 'Create or Update multiple ReportQueueSchedule at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportQueueSchedule parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportQueueSchedule' text/json: schema: type: array items: $ref: '#/components/schemas/ReportQueueSchedule' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportQueueSchedule' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-series: post: tags: - Report Series summary: Create ReportSeries description: Creates a new ReportSeries operationId: CreateReportSeries parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeries' text/json: schema: $ref: '#/components/schemas/ReportSeries' application/*+json: schema: $ref: '#/components/schemas/ReportSeries' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Series summary: List ReportSeries description: Lists all ReportSeries operationId: ListReportSeries parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: seriesType in: query description: Series Type (STANDARD | TEMPLATE) schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-series-users: get: tags: - Report Series summary: List ReportSeries Users description: Lists all ReportSeries operationId: ListReportSeriesUsers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-series/{reportSeriesKey}': get: tags: - Report Series summary: Get ReportSeries description: Gets ReportSeries operationId: GetReportSeries parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesKey in: path description: ReportSeries Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Series summary: Update ReportSeries description: Updates a specific ReportSeries. operationId: UpdateReportSeries parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesKey in: path description: ReportSeries Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeries' text/json: schema: $ref: '#/components/schemas/ReportSeries' application/*+json: schema: $ref: '#/components/schemas/ReportSeries' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Series summary: Delete ReportSeries description: Deletes an ReportSeries operationId: DeleteReportSeries parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesKey in: path description: ReportSeries Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-series-batch: put: tags: - Report Series summary: Create or Update Batch ReportSeries description: 'Create or Update multiple ReportSeries at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportSeries parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportSeries' text/json: schema: type: array items: $ref: '#/components/schemas/ReportSeries' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportSeries' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-series-processes: post: tags: - Report Series Processes summary: Create ReportSeriesProcess description: Creates a new ReportSeriesProcess operationId: CreateReportSeriesProcess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeriesProcess' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcess' application/*+json: schema: $ref: '#/components/schemas/ReportSeriesProcess' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesProcessVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Series Processes summary: List ReportSeriesProcess description: Lists all ReportSeriesProcess operationId: ListReportSeriesProcess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesProcessListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-series-processes/{reportSeriesProcessKey}': get: tags: - Report Series Processes summary: Get ReportSeriesProcess description: Gets ReportSeriesProcess operationId: GetReportSeriesProcess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesProcessKey in: path description: ReportSeriesProcess Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesProcessVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Series Processes summary: Update ReportSeriesProcess description: Updates a specific ReportSeriesProcess. operationId: UpdateReportSeriesProcess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesProcessKey in: path description: ReportSeriesProcess Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeriesProcess' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcess' application/*+json: schema: $ref: '#/components/schemas/ReportSeriesProcess' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesProcessVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Series Processes summary: Delete ReportSeriesProcess description: Deletes an ReportSeriesProcess operationId: DeleteReportSeriesProcess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesProcessKey in: path description: ReportSeriesProcess Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-series-processes-batch: put: tags: - Report Series Processes summary: Create or Update Batch ReportSeriesProcess description: 'Create or Update multiple ReportSeriesProcess at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportSeriesProcess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesProcess' text/json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesProcess' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesProcess' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-series-processes/{reportSeriesProcessKey}/arguments': post: tags: - Report Series Process Arguments summary: Create ReportSeriesProcessArg description: Creates a new ReportSeriesProcessArg operationId: CreateReportSeriesProcessArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesProcessKey in: path description: ReportSeriesProcess Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessArg' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessArg' application/*+json: schema: $ref: '#/components/schemas/ReportSeriesProcessArg' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesProcessArgVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessArgVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Series Process Arguments summary: List ReportSeriesProcessArg description: Lists all ReportSeriesProcessArg for the given reportSeriesProcessKey operationId: ListReportSeriesProcessArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesProcessKey in: path description: ReportSeriesProcess Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesProcessArgListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessArgListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessArgListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-series-processes/{reportSeriesProcessKey}/arguments/{argumentName}': get: tags: - Report Series Process Arguments summary: Get ReportSeriesProcessArg description: Gets ReportSeriesProcessArg operationId: GetReportSeriesProcessArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesProcessKey in: path description: ReportSeriesProcess Key required: true schema: type: integer format: int32 - name: argumentName in: path description: Argument Name required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesProcessArgVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessArgVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Series Process Arguments summary: Update ReportSeriesProcessArg description: Updates a specific ReportSeriesProcessArg. operationId: UpdateReportSeriesProcessArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesProcessKey in: path description: ReportSeriesProcess Key required: true schema: type: integer format: int32 - name: argumentName in: path description: Argument Name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessArg' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessArg' application/*+json: schema: $ref: '#/components/schemas/ReportSeriesProcessArg' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesProcessArgVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessArgVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Series Process Arguments summary: Delete ReportSeriesProcessArg description: Deletes an ReportSeriesProcessArg operationId: DeleteReportSeriesProcessArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesProcessKey in: path description: ReportSeriesProcess Key required: true schema: type: integer format: int32 - name: argumentName in: path description: Argument Name required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-series-processes/{reportSeriesProcessKey}/arguments-batch': put: tags: - Report Series Process Arguments summary: Create or Update Batch ReportSeriesProcessArg description: 'Create or Update multiple ReportSeriesProcessArg at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportSeriesProcessArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesProcessKey in: path description: ReportSeriesProcess Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesProcessArg' text/json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesProcessArg' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesProcessArg' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-series-process-templates: post: tags: - Report Series Process Templates summary: Create ReportSeriesProcessTemplate description: Creates a new ReportSeriesProcessTemplate operationId: CreateReportSeriesProcessTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplate' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplate' application/*+json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplateVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplateVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Series Process Templates summary: List ReportSeriesProcessTemplate description: Lists all ReportSeriesProcessTemplate operationId: ListReportSeriesProcessTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesKey in: query description: Filter by reportSeriesKey schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplateListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplateListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-series-process-templates/{reportSeriesProcessTemplateKey}': get: tags: - Report Series Process Templates summary: Get ReportSeriesProcessTemplate description: Gets ReportSeriesProcessTemplate operationId: GetReportSeriesProcessTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesProcessTemplateKey in: path description: ReportSeriesProcessTemplate Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplateVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplateVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Series Process Templates summary: Update ReportSeriesProcessTemplate description: Updates a specific ReportSeriesProcessTemplate. operationId: UpdateReportSeriesProcessTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesProcessTemplateKey in: path description: ReportSeriesProcessTemplate Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplate' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplate' application/*+json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplate' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplateVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplateVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesProcessTemplateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Series Process Templates summary: Delete ReportSeriesProcessTemplate description: Deletes an ReportSeriesProcessTemplate operationId: DeleteReportSeriesProcessTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesProcessTemplateKey in: path description: ReportSeriesProcessTemplate Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-series-process-templates-batch: put: tags: - Report Series Process Templates summary: Create or Update Batch ReportSeriesProcessTemplate description: 'Create or Update multiple ReportSeriesProcessTemplate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportSeriesProcessTemplate parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesProcessTemplate' text/json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesProcessTemplate' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesProcessTemplate' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-series-steps: post: tags: - Report Series Steps summary: Create ReportSeriesStep description: Creates a new ReportSeriesStep operationId: CreateReportSeriesStep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeriesStep' text/json: schema: $ref: '#/components/schemas/ReportSeriesStep' application/*+json: schema: $ref: '#/components/schemas/ReportSeriesStep' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesStepVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesStepVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesStepVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Series Steps summary: List ReportSeriesStep description: Lists all ReportSeriesStep operationId: ListReportSeriesStep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesKey in: query description: Filter by ReportSeries_Key schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesStepListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesStepListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesStepListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-series-steps/{reportSeriesStepKey}': get: tags: - Report Series Steps summary: Get ReportSeriesStep description: Gets ReportSeriesStep operationId: GetReportSeriesStep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesStepKey in: path description: ReportSeriesStep Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesStepVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesStepVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesStepVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Series Steps summary: Update ReportSeriesStep description: Updates a specific ReportSeriesStep. operationId: UpdateReportSeriesStep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesStepKey in: path description: ReportSeriesStep Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeriesStep' text/json: schema: $ref: '#/components/schemas/ReportSeriesStep' application/*+json: schema: $ref: '#/components/schemas/ReportSeriesStep' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesStepVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesStepVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesStepVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Series Steps summary: Delete ReportSeriesStep description: Deletes an ReportSeriesStep operationId: DeleteReportSeriesStep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesStepKey in: path description: ReportSeriesStep Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-series-steps-batch: put: tags: - Report Series Steps summary: Create or Update Batch ReportSeriesStep description: 'Create or Update multiple ReportSeriesStep at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportSeriesStep parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesStep' text/json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesStep' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesStep' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-series-step-args: post: tags: - Report Series Step Args summary: Create ReportSeriesStepArg description: Creates a new ReportSeriesStepArg operationId: CreateReportSeriesStepArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeriesStepArg' text/json: schema: $ref: '#/components/schemas/ReportSeriesStepArg' application/*+json: schema: $ref: '#/components/schemas/ReportSeriesStepArg' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesStepArgVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesStepArgVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesStepArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Series Step Args summary: List ReportSeriesStepArg description: Lists all ReportSeriesStepArg operationId: ListReportSeriesStepArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesStepKey in: query description: Filter by ReportSeriesStep_Key schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesStepArgListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesStepArgListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesStepArgListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-series-step-args/{reportSeriesStepArgKey}': get: tags: - Report Series Step Args summary: Get ReportSeriesStepArg description: Gets ReportSeriesStepArg operationId: GetReportSeriesStepArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesStepArgKey in: path description: ReportSeriesStepArg Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesStepArgVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesStepArgVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesStepArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Series Step Args summary: Update ReportSeriesStepArg description: Updates a specific ReportSeriesStepArg. operationId: UpdateReportSeriesStepArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesStepArgKey in: path description: ReportSeriesStepArg Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeriesStepArg' text/json: schema: $ref: '#/components/schemas/ReportSeriesStepArg' application/*+json: schema: $ref: '#/components/schemas/ReportSeriesStepArg' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesStepArgVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesStepArgVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesStepArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Series Step Args summary: Delete ReportSeriesStepArg description: Deletes an ReportSeriesStepArg operationId: DeleteReportSeriesStepArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesStepArgKey in: path description: ReportSeriesStepArg Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-series-step-args-batch: put: tags: - Report Series Step Args summary: Create or Update Batch ReportSeriesStepArg description: 'Create or Update multiple ReportSeriesStepArg at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportSeriesStepArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesStepArg' text/json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesStepArg' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesStepArg' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-series-trackins-args: post: tags: - Report Series Tracking Args summary: Create ReportSeriesTrackingArg description: Creates a new ReportSeriesTrackingArg operationId: CreateReportSeriesTrackingArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArg' text/json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArg' application/*+json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArg' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesTrackingArgVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArgVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Series Tracking Args summary: List ReportSeriesTrackingArg description: Lists all ReportSeriesTrackingArg operationId: ListReportSeriesTrackingArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesKey in: query description: Filter by ReportSeries_Key schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesTrackingArgListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArgListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArgListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-series-trackins-args/{reportSeriesTrackingArgKey}': get: tags: - Report Series Tracking Args summary: Get ReportSeriesTrackingArg description: Gets ReportSeriesTrackingArg operationId: GetReportSeriesTrackingArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesTrackingArgKey in: path description: ReportSeriesTrackingArg Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesTrackingArgVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArgVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Series Tracking Args summary: Update ReportSeriesTrackingArg description: Updates a specific ReportSeriesTrackingArg. operationId: UpdateReportSeriesTrackingArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesTrackingArgKey in: path description: ReportSeriesTrackingArg Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArg' text/json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArg' application/*+json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArg' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportSeriesTrackingArgVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArgVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportSeriesTrackingArgVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Series Tracking Args summary: Delete ReportSeriesTrackingArg description: Deletes an ReportSeriesTrackingArg operationId: DeleteReportSeriesTrackingArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportSeriesTrackingArgKey in: path description: ReportSeriesTrackingArg Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-series-trackins-args-batch: put: tags: - Report Series Tracking Args summary: Create or Update Batch ReportSeriesTrackingArg description: 'Create or Update multiple ReportSeriesTrackingArg at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportSeriesTrackingArg parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesTrackingArg' text/json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesTrackingArg' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportSeriesTrackingArg' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-tracks: post: tags: - Report Tracking summary: Create ReportTrack description: Creates a new ReportTrack operationId: CreateReportTrack parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTrack' text/json: schema: $ref: '#/components/schemas/ReportTrack' application/*+json: schema: $ref: '#/components/schemas/ReportTrack' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Tracking summary: List ReportTrack description: Lists all ReportTrack operationId: ListReportTrack parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-tracks/{reportTrackKey}': get: tags: - Report Tracking summary: Get ReportTrack description: Gets ReportTrack operationId: GetReportTrack parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportTrackKey in: path description: ReportTrack Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Tracking summary: Update ReportTrack description: Updates a specific ReportTrack. operationId: UpdateReportTrack parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportTrackKey in: path description: ReportTrack Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTrack' text/json: schema: $ref: '#/components/schemas/ReportTrack' application/*+json: schema: $ref: '#/components/schemas/ReportTrack' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Tracking summary: Delete ReportTrack description: Deletes an ReportTrack operationId: DeleteReportTrack parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportTrackKey in: path description: ReportTrack Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /report-tracks-batch: put: tags: - Report Tracking summary: Create or Update Batch ReportTrack description: 'Create or Update multiple ReportTrack at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportTrack parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportTrack' text/json: schema: type: array items: $ref: '#/components/schemas/ReportTrack' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportTrack' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/priorities': post: tags: - Report Tracking Priorities summary: Create ReportTrackPriority description: Creates a new ReportTrackPriority operationId: CreateReportTrackPriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTrackPriority' text/json: schema: $ref: '#/components/schemas/ReportTrackPriority' application/*+json: schema: $ref: '#/components/schemas/ReportTrackPriority' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackPriorityVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackPriorityVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackPriorityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Tracking Priorities summary: List ReportTrackPriority description: Lists all ReportTrackPriority for the given ReportDefinition_Key operationId: ListReportTrackPriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackPriorityListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackPriorityListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackPriorityListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/priorities/{priority}': get: tags: - Report Tracking Priorities summary: Get ReportTrackPriority description: Gets ReportTrackPriority operationId: GetReportTrackPriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: priority in: path description: Priority required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackPriorityVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackPriorityVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackPriorityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Tracking Priorities summary: Update ReportTrackPriority description: Updates a specific ReportTrackPriority. operationId: UpdateReportTrackPriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: priority in: path description: Priority required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTrackPriority' text/json: schema: $ref: '#/components/schemas/ReportTrackPriority' application/*+json: schema: $ref: '#/components/schemas/ReportTrackPriority' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackPriorityVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackPriorityVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackPriorityVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Tracking Priorities summary: Delete ReportTrackPriority description: Deletes an ReportTrackPriority operationId: DeleteReportTrackPriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: priority in: path description: Priority required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/priorities-batch': put: tags: - Report Tracking Priorities summary: Create or Update Batch ReportTrackPriority description: 'Create or Update multiple ReportTrackPriority at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportTrackPriority parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportTrackPriority' text/json: schema: type: array items: $ref: '#/components/schemas/ReportTrackPriority' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportTrackPriority' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/received-statuses': post: tags: - Report Tracking Received Statuses summary: Create ReportTrackReceivedStatus description: Creates a new ReportTrackReceivedStatus operationId: CreateReportTrackReceivedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatus' text/json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatus' application/*+json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackReceivedStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Tracking Received Statuses summary: List ReportTrackReceivedStatus description: Lists all ReportTrackReceivedStatus for the given ReportDefinition_Key operationId: ListReportTrackReceivedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackReceivedStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/received-statuses/{receivedStatus}': get: tags: - Report Tracking Received Statuses summary: Get ReportTrackReceivedStatus description: Gets ReportTrackReceivedStatus operationId: GetReportTrackReceivedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: receivedStatus in: path description: Received Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackReceivedStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Tracking Received Statuses summary: Update ReportTrackReceivedStatus description: Updates a specific ReportTrackReceivedStatus. operationId: UpdateReportTrackReceivedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: receivedStatus in: path description: Received Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatus' text/json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatus' application/*+json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackReceivedStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackReceivedStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Tracking Received Statuses summary: Delete ReportTrackReceivedStatus description: Deletes an ReportTrackReceivedStatus operationId: DeleteReportTrackReceivedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: receivedStatus in: path description: Received Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/received-statuses-batch': put: tags: - Report Tracking Received Statuses summary: Create or Update Batch ReportTrackReceivedStatus description: 'Create or Update multiple ReportTrackReceivedStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportTrackReceivedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportTrackReceivedStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ReportTrackReceivedStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportTrackReceivedStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/sent-statuses': post: tags: - Report Tracking Sent Statuses summary: Create ReportTrackSentStatus description: Creates a new ReportTrackSentStatus operationId: CreateReportTrackSentStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTrackSentStatus' text/json: schema: $ref: '#/components/schemas/ReportTrackSentStatus' application/*+json: schema: $ref: '#/components/schemas/ReportTrackSentStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackSentStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackSentStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackSentStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Tracking Sent Statuses summary: List ReportTrackSentStatus description: Lists all ReportTrackSentStatus for the given ReportDefinition_Key operationId: ListReportTrackSentStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackSentStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackSentStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackSentStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/sent-statuses/{sentStatus}': get: tags: - Report Tracking Sent Statuses summary: Get ReportTrackSentStatus description: Gets ReportTrackSentStatus operationId: GetReportTrackSentStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: sentStatus in: path description: Sent Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackSentStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackSentStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackSentStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Tracking Sent Statuses summary: Update ReportTrackSentStatus description: Updates a specific ReportTrackSentStatus. operationId: UpdateReportTrackSentStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: sentStatus in: path description: Sent Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTrackSentStatus' text/json: schema: $ref: '#/components/schemas/ReportTrackSentStatus' application/*+json: schema: $ref: '#/components/schemas/ReportTrackSentStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackSentStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackSentStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackSentStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Tracking Sent Statuses summary: Delete ReportTrackSentStatus description: Deletes an ReportTrackSentStatus operationId: DeleteReportTrackSentStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: sentStatus in: path description: Sent Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/sent-statuses-batch': put: tags: - Report Tracking Sent Statuses summary: Create or Update Batch ReportTrackSentStatus description: 'Create or Update multiple ReportTrackSentStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportTrackSentStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportTrackSentStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ReportTrackSentStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportTrackSentStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/sent-to': post: tags: - Report Tracking Sent To summary: Create ReportTrackSentTo description: Creates a new ReportTrackSentTo operationId: CreateReportTrackSentTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTrackSentTo' text/json: schema: $ref: '#/components/schemas/ReportTrackSentTo' application/*+json: schema: $ref: '#/components/schemas/ReportTrackSentTo' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackSentToVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackSentToVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackSentToVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Tracking Sent To summary: List ReportTrackSentTo description: Lists all ReportTrackSentTo for the given reportDefinitionKey operationId: ListReportTrackSentTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackSentToListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackSentToListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackSentToListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/sent-to/{sentTo}': get: tags: - Report Tracking Sent To summary: Get ReportTrackSentTo description: Gets ReportTrackSentTo operationId: GetReportTrackSentTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: sentTo in: path description: Sent To required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackSentToVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackSentToVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackSentToVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Tracking Sent To summary: Update ReportTrackSentTo description: Updates a specific ReportTrackSentTo. operationId: UpdateReportTrackSentTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: sentTo in: path description: Sent To required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTrackSentTo' text/json: schema: $ref: '#/components/schemas/ReportTrackSentTo' application/*+json: schema: $ref: '#/components/schemas/ReportTrackSentTo' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackSentToVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackSentToVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackSentToVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Tracking Sent To summary: Delete ReportTrackSentTo description: Deletes an ReportTrackSentTo operationId: DeleteReportTrackSentTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: sentTo in: path description: Sent To required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/sent-to-batch': put: tags: - Report Tracking Sent To summary: Create or Update Batch ReportTrackSentTo description: 'Create or Update multiple ReportTrackSentTo at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportTrackSentTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportTrackSentTo' text/json: schema: type: array items: $ref: '#/components/schemas/ReportTrackSentTo' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportTrackSentTo' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/tracking-statuses': post: tags: - Report Tracking Statuses summary: Create ReportTrackStatus description: Creates a new ReportTrackStatus operationId: CreateReportTrackStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTrackStatus' text/json: schema: $ref: '#/components/schemas/ReportTrackStatus' application/*+json: schema: $ref: '#/components/schemas/ReportTrackStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Report Tracking Statuses summary: List ReportTrackStatus description: Lists all ReportTrackStatus for the given reportDefinitionKey operationId: ListReportTrackStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/tracking-statuses/{trackingStatus}': get: tags: - Report Tracking Statuses summary: Get ReportTrackStatus description: Gets ReportTrackStatus operationId: GetReportTrackStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: trackingStatus in: path description: Tracking Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Report Tracking Statuses summary: Update ReportTrackStatus description: Updates a specific ReportTrackStatus. operationId: UpdateReportTrackStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: trackingStatus in: path description: Tracking Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTrackStatus' text/json: schema: $ref: '#/components/schemas/ReportTrackStatus' application/*+json: schema: $ref: '#/components/schemas/ReportTrackStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReportTrackStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReportTrackStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReportTrackStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Report Tracking Statuses summary: Delete ReportTrackStatus description: Deletes an ReportTrackStatus operationId: DeleteReportTrackStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 - name: trackingStatus in: path description: Tracking Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/report-definitions/{reportDefinitionKey}/tracking-statuses-batch': put: tags: - Report Tracking Statuses summary: Create or Update Batch ReportTrackStatus description: 'Create or Update multiple ReportTrackStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReportTrackStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportTrackStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ReportTrackStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReportTrackStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-batch-reviewed-status: post: tags: - Reviewed Status summary: Create ReviewedStatus description: Creates a new ReviewedStatus operationId: CreateReviewedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReviewedStatus' text/json: schema: $ref: '#/components/schemas/ReviewedStatus' application/*+json: schema: $ref: '#/components/schemas/ReviewedStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReviewedStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReviewedStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReviewedStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Reviewed Status summary: List ReviewedStatus description: Lists all ReviewedStatus operationId: ListReviewedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReviewedStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/ReviewedStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/ReviewedStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/claim-batch-reviewed-status/{Reviewed_Status}': get: tags: - Reviewed Status summary: Get ReviewedStatus description: Gets ReviewedStatus operationId: GetReviewedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Reviewed_Status in: path description: Reviewed Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReviewedStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReviewedStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReviewedStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Reviewed Status summary: Update ReviewedStatus description: Updates a specific ReviewedStatus. operationId: UpdateReviewedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Reviewed_Status in: path description: Reviewed Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReviewedStatus' text/json: schema: $ref: '#/components/schemas/ReviewedStatus' application/*+json: schema: $ref: '#/components/schemas/ReviewedStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ReviewedStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/ReviewedStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/ReviewedStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Reviewed Status summary: Delete ReviewedStatus description: Deletes an ReviewedStatus operationId: DeleteReviewedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Reviewed_Status in: path description: Reviewed Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /claim-batch-reviewed-status-batch: put: tags: - Reviewed Status summary: Create or Update Batch ReviewedStatus description: 'Create or Update multiple ReviewedStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchReviewedStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ReviewedStatus' text/json: schema: type: array items: $ref: '#/components/schemas/ReviewedStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/ReviewedStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /search: post: tags: - Search Request summary: Run a search description: Runs a search usng the provided Search Request operationId: SearchRequest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchRequest' text/json: schema: $ref: '#/components/schemas/SearchRequest' application/*+json: schema: $ref: '#/components/schemas/SearchRequest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SearchResultVBAResponse' application/json: schema: $ref: '#/components/schemas/SearchResultVBAResponse' text/json: schema: $ref: '#/components/schemas/SearchResultVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /search-configs: get: tags: - Search Config summary: List SearchConfigs description: Gets a list of SearchConfigs with optional FunctionalArea filter operationId: ListSearchConfigs parameters: - name: vbasoftware-database in: header description: target database for this request required: true schema: type: string - name: functionalArea in: query description: Functional Area schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SearchConfigListVBAResponse' application/json: schema: $ref: '#/components/schemas/SearchConfigListVBAResponse' text/json: schema: $ref: '#/components/schemas/SearchConfigListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/search-configs/{searchConfigId}': get: tags: - Search Config summary: Get a SearchConfig description: Get a specific SearchConfig operationId: GetSearchConfig parameters: - name: vbasoftware-database in: header description: target database for this request required: true schema: type: string - name: searchConfigId in: path description: SearchConfig id required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SearchConfigVBAResponse' application/json: schema: $ref: '#/components/schemas/SearchConfigVBAResponse' text/json: schema: $ref: '#/components/schemas/SearchConfigVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-areas: post: tags: - Security Areas summary: Create SecurityArea description: Creates a new SecurityArea operationId: CreateSecurityArea parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityArea' text/json: schema: $ref: '#/components/schemas/SecurityArea' application/*+json: schema: $ref: '#/components/schemas/SecurityArea' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security Areas summary: List SecurityArea description: 'Lists all SecurityArea ' operationId: ListSecurityArea parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-areas/{securityArea}': get: tags: - Security Areas summary: Get SecurityArea description: Gets SecurityArea operationId: GetSecurityArea parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Areas summary: Update SecurityArea description: Updates a specific SecurityArea. operationId: UpdateSecurityArea parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityArea' text/json: schema: $ref: '#/components/schemas/SecurityArea' application/*+json: schema: $ref: '#/components/schemas/SecurityArea' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security Areas summary: Delete SecurityArea description: Deletes an SecurityArea operationId: DeleteSecurityArea parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-areas-batch: put: tags: - Security Areas summary: Create or Update Batch SecurityArea description: 'Create or Update multiple SecurityArea at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityArea parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityArea' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityArea' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityArea' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-areas/{securityArea}/objects': post: tags: - Security Area Objects summary: Create SecurityAreaObject description: Creates a new SecurityAreaObject operationId: CreateSecurityAreaObject parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityAreaObject' text/json: schema: $ref: '#/components/schemas/SecurityAreaObject' application/*+json: schema: $ref: '#/components/schemas/SecurityAreaObject' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaObjectVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaObjectVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaObjectVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security Area Objects summary: List SecurityAreaObject description: Lists all SecurityAreaObject securityArea operationId: ListSecurityAreaObject parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaObjectListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaObjectListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaObjectListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Area Objects summary: Create or Update Batch SecurityAreaObject description: 'Create or Update multiple SecurityAreaObject at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityAreaObject parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaObject' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaObject' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaObject' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-areas/{securityArea}/objects/{objectName}': get: tags: - Security Area Objects summary: Get SecurityAreaObject description: Gets SecurityAreaObject operationId: GetSecurityAreaObject parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string - name: objectName in: path description: Object Name required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaObjectVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaObjectVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaObjectVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Area Objects summary: Update SecurityAreaObject description: Updates a specific SecurityAreaObject. operationId: UpdateSecurityAreaObject parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string - name: objectName in: path description: Object Name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityAreaObject' text/json: schema: $ref: '#/components/schemas/SecurityAreaObject' application/*+json: schema: $ref: '#/components/schemas/SecurityAreaObject' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaObjectVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaObjectVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaObjectVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security Area Objects summary: Delete SecurityAreaObject description: Deletes an SecurityAreaObject operationId: DeleteSecurityAreaObject parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string - name: objectName in: path description: Object Name required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-area-overrides: post: tags: - Security Area Overrides summary: Create SecurityAreaOverride description: Creates a new SecurityAreaOverride operationId: CreateSecurityAreaOverride parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityAreaOverride' text/json: schema: $ref: '#/components/schemas/SecurityAreaOverride' application/*+json: schema: $ref: '#/components/schemas/SecurityAreaOverride' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaOverrideVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaOverrideVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaOverrideVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security Area Overrides summary: List SecurityAreaOverride description: Lists all SecurityAreaOverride with optional securityArea filter operationId: ListSecurityAreaOverride parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: query description: Security Area schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaOverrideListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaOverrideListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaOverrideListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Area Overrides summary: Create or Update Batch SecurityAreaOverride description: 'Create or Update multiple SecurityAreaOverride at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityAreaOverride parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaOverride' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaOverride' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaOverride' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-area-overrides/{securityAreaOverrideKey}': get: tags: - Security Area Overrides summary: Get SecurityAreaOverride description: Gets SecurityAreaOverride operationId: GetSecurityAreaOverride parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityAreaOverrideKey in: path description: SecurityAreaOverride Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaOverrideVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaOverrideVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaOverrideVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Area Overrides summary: Update SecurityAreaOverride description: Updates a specific SecurityAreaOverride. operationId: UpdateSecurityAreaOverride parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityAreaOverrideKey in: path description: SecurityAreaOverride Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityAreaOverride' text/json: schema: $ref: '#/components/schemas/SecurityAreaOverride' application/*+json: schema: $ref: '#/components/schemas/SecurityAreaOverride' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaOverrideVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaOverrideVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaOverrideVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security Area Overrides summary: Delete SecurityAreaOverride description: Deletes an SecurityAreaOverride operationId: DeleteSecurityAreaOverride parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityAreaOverrideKey in: path description: SecurityAreaOverride Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-areas/{securityArea}/reports': post: tags: - Security Area Reports summary: Create SecurityAreaReport description: Creates a new SecurityAreaReport operationId: CreateSecurityAreaReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityAreaReport' text/json: schema: $ref: '#/components/schemas/SecurityAreaReport' application/*+json: schema: $ref: '#/components/schemas/SecurityAreaReport' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaReportVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaReportVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaReportVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security Area Reports summary: List SecurityAreaReport description: Lists all SecurityAreaReport securityArea operationId: ListSecurityAreaReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaReportListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaReportListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaReportListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Area Reports summary: Create or Update Batch SecurityAreaReport description: 'Create or Update multiple SecurityAreaReport at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityAreaReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaReport' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaReport' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaReport' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-areas/{securityArea}/reports/{reportDefinitionKey}': get: tags: - Security Area Reports summary: Get SecurityAreaReport description: Gets SecurityAreaReport operationId: GetSecurityAreaReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaReportVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaReportVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaReportVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Area Reports summary: Update SecurityAreaReport description: Updates a specific SecurityAreaReport. operationId: UpdateSecurityAreaReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityAreaReport' text/json: schema: $ref: '#/components/schemas/SecurityAreaReport' application/*+json: schema: $ref: '#/components/schemas/SecurityAreaReport' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaReportVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaReportVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaReportVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security Area Reports summary: Delete SecurityAreaReport description: Deletes an SecurityAreaReport operationId: DeleteSecurityAreaReport parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string - name: reportDefinitionKey in: path description: ReportDefinition Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-areas/{securityArea}/users': post: tags: - Security Area Users summary: Create SecurityAreaUser description: Creates a new SecurityAreaUser operationId: CreateSecurityAreaUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityAreaUser' text/json: schema: $ref: '#/components/schemas/SecurityAreaUser' application/*+json: schema: $ref: '#/components/schemas/SecurityAreaUser' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaUserVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaUserVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security Area Users summary: List SecurityAreaUser description: Lists all SecurityAreaUser given securityArea operationId: ListSecurityAreaUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaUserListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaUserListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaUserListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-areas/{securityArea}/users/{userID}': get: tags: - Security Area Users summary: Get SecurityAreaUser description: Gets SecurityAreaUser operationId: GetSecurityAreaUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaUserVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaUserVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Area Users summary: Update SecurityAreaUser description: Updates a specific SecurityAreaUser. operationId: UpdateSecurityAreaUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityAreaUser' text/json: schema: $ref: '#/components/schemas/SecurityAreaUser' application/*+json: schema: $ref: '#/components/schemas/SecurityAreaUser' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaUserVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaUserVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security Area Users summary: Delete SecurityAreaUser description: Deletes an SecurityAreaUser operationId: DeleteSecurityAreaUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-areas/{securityArea}/users-batch': put: tags: - Security Area Users summary: Create or Update Batch SecurityAreaUser description: 'Create or Update multiple SecurityAreaUser at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityAreaUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaUser' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaUser' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaUser' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-area-users: get: tags: - Security Area Users summary: List SecurityAreaUser for a User ID description: Lists all SecurityAreaUser objects for a given User ID. This will show all of the Areas in which a User is a member. operationId: ListSecurityAreasForUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: query description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaUserListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaUserListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaUserListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-areas/{securityArea}/user-groups': post: tags: - Security Area User Groups summary: Create SecurityAreaUserGroup description: Creates a new SecurityAreaUserGroup operationId: CreateSecurityAreaUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityAreaUserGroup' text/json: schema: $ref: '#/components/schemas/SecurityAreaUserGroup' application/*+json: schema: $ref: '#/components/schemas/SecurityAreaUserGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaUserGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaUserGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaUserGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security Area User Groups summary: List SecurityAreaUserGroup description: Lists all SecurityAreaUserGroup securityArea operationId: ListSecurityAreaUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaUserGroupListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaUserGroupListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaUserGroupListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Area User Groups summary: Create or Update Batch SecurityAreaUserGroup description: 'Create or Update multiple SecurityAreaUserGroup at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityAreaUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaUserGroup' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaUserGroup' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityAreaUserGroup' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-areas/{securityArea}/user-groups/{userGroupKey}': get: tags: - Security Area User Groups summary: Get SecurityAreaUserGroup description: Gets SecurityAreaUserGroup operationId: GetSecurityAreaUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityAreaUserGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityAreaUserGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityAreaUserGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security Area User Groups summary: Delete SecurityAreaUserGroup description: Deletes an SecurityAreaUserGroup operationId: DeleteSecurityAreaUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityArea in: path description: Security Area required: true schema: type: string - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /secure-groups: get: tags: - Security Area User Groups summary: List Secure Groups description: Lists all Secure Groups for a given User ID operationId: ListSecureGroupsForUserID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: query description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-fields: post: tags: - Security Fields summary: Create SecurityField description: Creates a new SecurityField operationId: CreateSecurityField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityField' text/json: schema: $ref: '#/components/schemas/SecurityField' application/*+json: schema: $ref: '#/components/schemas/SecurityField' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security Fields summary: List SecurityField description: Lists all SecurityField operationId: ListSecurityField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-fields/{SecurityField_ID}': get: tags: - Security Fields summary: Get SecurityField description: Gets SecurityField operationId: GetSecurityField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityField_ID in: path description: SecurityField ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Fields summary: Update SecurityField description: Updates a specific SecurityField. operationId: UpdateSecurityField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityField_ID in: path description: SecurityField ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityField' text/json: schema: $ref: '#/components/schemas/SecurityField' application/*+json: schema: $ref: '#/components/schemas/SecurityField' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security Fields summary: Delete SecurityField description: Deletes an SecurityField operationId: DeleteSecurityField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityField_ID in: path description: SecurityField ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-fields-batch: put: tags: - Security Fields summary: Create or Update Batch SecurityField description: 'Create or Update multiple SecurityField at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityField parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityField' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityField' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityField' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-field-sets: post: tags: - Security Field Sets summary: Create SecurityFieldSet description: Creates a new SecurityFieldSet operationId: CreateSecurityFieldSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityFieldSet' text/json: schema: $ref: '#/components/schemas/SecurityFieldSet' application/*+json: schema: $ref: '#/components/schemas/SecurityFieldSet' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldSetVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldSetVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldSetVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security Field Sets summary: List SecurityFieldSet description: Lists all SecurityFieldSet operationId: ListSecurityFieldSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldSetListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldSetListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldSetListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-field-sets/{SecurityFieldSet_ID}': get: tags: - Security Field Sets summary: Get SecurityFieldSet description: Gets SecurityFieldSet operationId: GetSecurityFieldSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldSet_ID in: path description: SecurityFieldSet ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldSetVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldSetVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldSetVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Field Sets summary: Update SecurityFieldSet description: Updates a specific SecurityFieldSet. operationId: UpdateSecurityFieldSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldSet_ID in: path description: SecurityFieldSet ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityFieldSet' text/json: schema: $ref: '#/components/schemas/SecurityFieldSet' application/*+json: schema: $ref: '#/components/schemas/SecurityFieldSet' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldSetVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldSetVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldSetVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security Field Sets summary: Delete SecurityFieldSet description: Deletes an SecurityFieldSet operationId: DeleteSecurityFieldSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldSet_ID in: path description: SecurityFieldSet ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-field-sets-batch: put: tags: - Security Field Sets summary: Create or Update Batch SecurityFieldSet description: 'Create or Update multiple SecurityFieldSet at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityFieldSet parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityFieldSet' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityFieldSet' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityFieldSet' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-field-sets/{SecurityFieldSet_ID}/fields/{SecurityField_ID}/details': post: tags: - Security Field Set Details summary: Create SecurityFieldSetDetail description: Creates a new SecurityFieldSetDetail operationId: CreateSecurityFieldSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldSet_ID in: path description: SecurityFieldSet ID required: true schema: type: string - name: SecurityField_ID in: path description: SecurityField ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityFieldSetDetail' text/json: schema: $ref: '#/components/schemas/SecurityFieldSetDetail' application/*+json: schema: $ref: '#/components/schemas/SecurityFieldSetDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldSetDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldSetDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldSetDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security Field Set Details summary: Get SecurityFieldSetDetail description: Gets SecurityFieldSetDetail operationId: GetSecurityFieldSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldSet_ID in: path description: SecurityFieldSet ID required: true schema: type: string - name: SecurityField_ID in: path description: SecurityField ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldSetDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldSetDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldSetDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Field Set Details summary: Update SecurityFieldSetDetail description: Updates a specific SecurityFieldSetDetail. operationId: UpdateSecurityFieldSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldSet_ID in: path description: SecurityFieldSet ID required: true schema: type: string - name: SecurityField_ID in: path description: SecurityField ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityFieldSetDetail' text/json: schema: $ref: '#/components/schemas/SecurityFieldSetDetail' application/*+json: schema: $ref: '#/components/schemas/SecurityFieldSetDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldSetDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldSetDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldSetDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security Field Set Details summary: Delete SecurityFieldSetDetail description: Deletes an SecurityFieldSetDetail operationId: DeleteSecurityFieldSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldSet_ID in: path description: SecurityFieldSet ID required: true schema: type: string - name: SecurityField_ID in: path description: SecurityField ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-field-sets/{SecurityFieldSet_ID}/details': get: tags: - Security Field Set Details summary: List SecurityFieldSetDetail description: Lists all SecurityFieldSetDetail for the given SecurityFieldSet_ID operationId: ListSecurityFieldSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldSet_ID in: path description: SecurityFieldSet ID required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldSetDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldSetDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldSetDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-field-sets/{SecurityFieldSet_ID}/details-batch': put: tags: - Security Field Set Details summary: Create or Update Batch SecurityFieldSetDetail description: 'Create or Update multiple SecurityFieldSetDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityFieldSetDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldSet_ID in: path description: SecurityFieldSet ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityFieldSetDetail' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityFieldSetDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityFieldSetDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-field-users: post: tags: - Security Field Users summary: Create SecurityFieldUser description: Creates a new SecurityFieldUser operationId: CreateSecurityFieldUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityFieldUser' text/json: schema: $ref: '#/components/schemas/SecurityFieldUser' application/*+json: schema: $ref: '#/components/schemas/SecurityFieldUser' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldUserVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldUserVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security Field Users summary: List SecurityFieldUser description: Lists all SecurityFieldUser operationId: ListSecurityFieldUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldUserListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldUserListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldUserListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-field-users/{SecurityFieldUser_Key}': get: tags: - Security Field Users summary: Get SecurityFieldUser description: Gets SecurityFieldUser operationId: GetSecurityFieldUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldUser_Key in: path description: SecurityFieldUser Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldUserVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldUserVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Field Users summary: Update SecurityFieldUser description: Updates a specific SecurityFieldUser. operationId: UpdateSecurityFieldUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldUser_Key in: path description: SecurityFieldUser Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityFieldUser' text/json: schema: $ref: '#/components/schemas/SecurityFieldUser' application/*+json: schema: $ref: '#/components/schemas/SecurityFieldUser' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldUserVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldUserVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security Field Users summary: Delete SecurityFieldUser description: Deletes an SecurityFieldUser operationId: DeleteSecurityFieldUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldUser_Key in: path description: SecurityFieldUser Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-field-users-batch: put: tags: - Security Field Users summary: Create or Update Batch SecurityFieldUser description: 'Create or Update multiple SecurityFieldUser at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityFieldUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityFieldUser' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityFieldUser' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityFieldUser' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-field-user-groups: post: tags: - Security Field User Groups summary: Create SecurityFieldUserGroup description: Creates a new SecurityFieldUserGroup operationId: CreateSecurityFieldUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityFieldUserGroup' text/json: schema: $ref: '#/components/schemas/SecurityFieldUserGroup' application/*+json: schema: $ref: '#/components/schemas/SecurityFieldUserGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldUserGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldUserGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldUserGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security Field User Groups summary: List SecurityFieldUserGroup description: Lists all SecurityFieldUserGroup operationId: ListSecurityFieldUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldUserGroupListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldUserGroupListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldUserGroupListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-field-user-groups/{SecurityFieldUserGroup_Key}': get: tags: - Security Field User Groups summary: Get SecurityFieldUserGroup description: Gets SecurityFieldUserGroup operationId: GetSecurityFieldUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldUserGroup_Key in: path description: SecurityFieldUserGroup Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldUserGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldUserGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldUserGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Field User Groups summary: Update SecurityFieldUserGroup description: Updates a specific SecurityFieldUserGroup. operationId: UpdateSecurityFieldUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldUserGroup_Key in: path description: SecurityFieldUserGroup Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityFieldUserGroup' text/json: schema: $ref: '#/components/schemas/SecurityFieldUserGroup' application/*+json: schema: $ref: '#/components/schemas/SecurityFieldUserGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityFieldUserGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityFieldUserGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityFieldUserGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security Field User Groups summary: Delete SecurityFieldUserGroup description: Deletes an SecurityFieldUserGroup operationId: DeleteSecurityFieldUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SecurityFieldUserGroup_Key in: path description: SecurityFieldUserGroup Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-field-user-groups-batch: put: tags: - Security Field User Groups summary: Create or Update Batch SecurityFieldUserGroup description: 'Create or Update multiple SecurityFieldUserGroup at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityFieldUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityFieldUserGroup' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityFieldUserGroup' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityFieldUserGroup' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-group-division-users: post: tags: - Security Group Division Users summary: Create SecurityGroupDivisionUser description: Creates a new SecurityGroupDivisionUser operationId: CreateSecurityGroupDivisionUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUser' text/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUser' application/*+json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUser' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security Group Division Users summary: List SecurityGroupDivisionUser description: Lists all SecurityGroupDivisionUser with optional userID and groupID filters operationId: ListSecurityGroupDivisionUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: query description: User ID Filter schema: type: string - name: groupID in: query description: Group ID Filter schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-group-division-users/{securityGroupDivisionUserKey}': get: tags: - Security Group Division Users summary: Get SecurityGroupDivisionUser description: Gets SecurityGroupDivisionUser operationId: GetSecurityGroupDivisionUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityGroupDivisionUserKey in: path description: SecurityGroupDivisionUser Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Group Division Users summary: Update SecurityGroupDivisionUser description: Updates a specific SecurityGroupDivisionUser. operationId: UpdateSecurityGroupDivisionUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityGroupDivisionUserKey in: path description: SecurityGroupDivisionUser Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUser' text/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUser' application/*+json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUser' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security Group Division Users summary: Delete SecurityGroupDivisionUser description: Deletes an SecurityGroupDivisionUser operationId: DeleteSecurityGroupDivisionUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityGroupDivisionUserKey in: path description: SecurityGroupDivisionUser Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-group-division-users-batch: put: tags: - Security Group Division Users summary: Create or Update Batch SecurityGroupDivisionUser description: 'Create or Update multiple SecurityGroupDivisionUser at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityGroupDivisionUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityGroupDivisionUser' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityGroupDivisionUser' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityGroupDivisionUser' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-group-division-user-groups: post: tags: - Security Group Division User Groups summary: Create SecurityGroupDivisionUserGroup description: Creates a new SecurityGroupDivisionUserGroup operationId: CreateSecurityGroupDivisionUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroup' text/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroup' application/*+json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security Group Division User Groups summary: List SecurityGroupDivisionUserGroup description: Lists all SecurityGroupDivisionUserGroup with optional groupID filter operationId: ListSecurityGroupDivisionUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: query description: Group ID schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroupListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroupListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroupListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-group-division-user-groups/{securityGroupDivisionUserGroupKey}': get: tags: - Security Group Division User Groups summary: Get SecurityGroupDivisionUserGroup description: Gets SecurityGroupDivisionUserGroup operationId: GetSecurityGroupDivisionUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityGroupDivisionUserGroupKey in: path description: SecurityGroupDivisionUserGroup Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security Group Division User Groups summary: Update SecurityGroupDivisionUserGroup description: Updates a specific SecurityGroupDivisionUserGroup. operationId: UpdateSecurityGroupDivisionUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityGroupDivisionUserGroupKey in: path description: SecurityGroupDivisionUserGroup Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroup' text/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroup' application/*+json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityGroupDivisionUserGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security Group Division User Groups summary: Delete SecurityGroupDivisionUserGroup description: Deletes an SecurityGroupDivisionUserGroup operationId: DeleteSecurityGroupDivisionUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityGroupDivisionUserGroupKey in: path description: SecurityGroupDivisionUserGroup Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-group-division-user-groups-batch: put: tags: - Security Group Division User Groups summary: Create or Update Batch SecurityGroupDivisionUserGroup description: 'Create or Update multiple SecurityGroupDivisionUserGroup at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityGroupDivisionUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityGroupDivisionUserGroup' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityGroupDivisionUserGroup' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityGroupDivisionUserGroup' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-levels: get: tags: - Security Levels summary: List SecurityLevel description: 'Lists all SecurityLevel ' operationId: ListSecurityLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityLevelListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityLevelListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityLevelListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-levels/{securityLevel}': get: tags: - Security Levels summary: Get SecurityLevel description: Gets SecurityLevel operationId: GetSecurityLevel parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityLevel in: path description: Security Level required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityLevelVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityLevelVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityLevelVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-user-limit-member-clam-data: post: tags: - Security User Limit Member Claim Data summary: Create SecurityUserLimitMemberClaimData description: Creates a new SecurityUserLimitMemberClaimData operationId: CreateSecurityUserLimitMemberClaimData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimData' text/json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimData' application/*+json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimData' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimDataVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimDataVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimDataVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security User Limit Member Claim Data summary: List SecurityUserLimitMemberClaimData description: Lists all SecurityUserLimitMemberClaimData operationId: ListSecurityUserLimitMemberClaimData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimDataListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimDataListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimDataListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-user-limit-member-clam-data/{securityUserLimitMemberClaimDataKey}': get: tags: - Security User Limit Member Claim Data summary: Get SecurityUserLimitMemberClaimData description: Gets SecurityUserLimitMemberClaimData operationId: GetSecurityUserLimitMemberClaimData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityUserLimitMemberClaimDataKey in: path description: SecurityUserLimitMemberClaimData Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimDataVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimDataVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimDataVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security User Limit Member Claim Data summary: Update SecurityUserLimitMemberClaimData description: Updates a specific SecurityUserLimitMemberClaimData. operationId: UpdateSecurityUserLimitMemberClaimData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityUserLimitMemberClaimDataKey in: path description: SecurityUserLimitMemberClaimData Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimData' text/json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimData' application/*+json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimData' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimDataVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimDataVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityUserLimitMemberClaimDataVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security User Limit Member Claim Data summary: Delete SecurityUserLimitMemberClaimData description: Deletes an SecurityUserLimitMemberClaimData operationId: DeleteSecurityUserLimitMemberClaimData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityUserLimitMemberClaimDataKey in: path description: SecurityUserLimitMemberClaimData Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-user-limit-member-clam-data-batch: put: tags: - Security User Limit Member Claim Data summary: Create or Update Batch SecurityUserLimitMemberClaimData description: 'Create or Update multiple SecurityUserLimitMemberClaimData at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityUserLimitMemberClaimData parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityUserLimitMemberClaimData' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityUserLimitMemberClaimData' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityUserLimitMemberClaimData' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-user-restrictions: post: tags: - Security User Restrictions summary: Create SecurityUserRestriction description: Creates a new SecurityUserRestriction operationId: CreateSecurityUserRestriction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityUserRestriction' text/json: schema: $ref: '#/components/schemas/SecurityUserRestriction' application/*+json: schema: $ref: '#/components/schemas/SecurityUserRestriction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityUserRestrictionVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityUserRestrictionVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityUserRestrictionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Security User Restrictions summary: List SecurityUserRestriction description: Lists all SecurityUserRestriction operationId: ListSecurityUserRestriction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityUserRestrictionListVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityUserRestrictionListVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityUserRestrictionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/security-user-restrictions/{securityUserRestrictionKey}': get: tags: - Security User Restrictions summary: Get SecurityUserRestriction description: Gets SecurityUserRestriction operationId: GetSecurityUserRestriction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityUserRestrictionKey in: path description: SecurityUserRestriction Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityUserRestrictionVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityUserRestrictionVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityUserRestrictionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Security User Restrictions summary: Update SecurityUserRestriction description: Updates a specific SecurityUserRestriction. operationId: UpdateSecurityUserRestriction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityUserRestrictionKey in: path description: SecurityUserRestriction Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityUserRestriction' text/json: schema: $ref: '#/components/schemas/SecurityUserRestriction' application/*+json: schema: $ref: '#/components/schemas/SecurityUserRestriction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SecurityUserRestrictionVBAResponse' application/json: schema: $ref: '#/components/schemas/SecurityUserRestrictionVBAResponse' text/json: schema: $ref: '#/components/schemas/SecurityUserRestrictionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Security User Restrictions summary: Delete SecurityUserRestriction description: Deletes an SecurityUserRestriction operationId: DeleteSecurityUserRestriction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: securityUserRestrictionKey in: path description: SecurityUserRestriction Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /security-user-restrictions-batch: put: tags: - Security User Restrictions summary: Create or Update Batch SecurityUserRestriction description: 'Create or Update multiple SecurityUserRestriction at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSecurityUserRestriction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityUserRestriction' text/json: schema: type: array items: $ref: '#/components/schemas/SecurityUserRestriction' application/*+json: schema: type: array items: $ref: '#/components/schemas/SecurityUserRestriction' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /send-tos: post: tags: - Send To summary: Create SendTo description: Creates a new SendTo operationId: CreateSendTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SendTo' text/json: schema: $ref: '#/components/schemas/SendTo' application/*+json: schema: $ref: '#/components/schemas/SendTo' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SendToVBAResponse' application/json: schema: $ref: '#/components/schemas/SendToVBAResponse' text/json: schema: $ref: '#/components/schemas/SendToVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Send To summary: List SendTo description: Lists all SendTo operationId: ListSendTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SendToListVBAResponse' application/json: schema: $ref: '#/components/schemas/SendToListVBAResponse' text/json: schema: $ref: '#/components/schemas/SendToListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/send-tos/{sendToID}': get: tags: - Send To summary: Get SendTo description: Gets SendTo operationId: GetSendTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sendToID in: path description: SendTo ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SendToVBAResponse' application/json: schema: $ref: '#/components/schemas/SendToVBAResponse' text/json: schema: $ref: '#/components/schemas/SendToVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Send To summary: Update SendTo description: Updates a specific SendTo. operationId: UpdateSendTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sendToID in: path description: SendTo ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SendTo' text/json: schema: $ref: '#/components/schemas/SendTo' application/*+json: schema: $ref: '#/components/schemas/SendTo' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SendToVBAResponse' application/json: schema: $ref: '#/components/schemas/SendToVBAResponse' text/json: schema: $ref: '#/components/schemas/SendToVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Send To summary: Delete SendTo description: Deletes an SendTo operationId: DeleteSendTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sendToID in: path description: SendTo ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /send-tos-batch: put: tags: - Send To summary: Create or Update Batch SendTo description: 'Create or Update multiple SendTo at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSendTo parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SendTo' text/json: schema: type: array items: $ref: '#/components/schemas/SendTo' application/*+json: schema: type: array items: $ref: '#/components/schemas/SendTo' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /signatures: post: tags: - Signatures summary: Create Signature description: Creates a new Signature operationId: CreateSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Signature' text/json: schema: $ref: '#/components/schemas/Signature' application/*+json: schema: $ref: '#/components/schemas/Signature' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SignatureVBAResponse' application/json: schema: $ref: '#/components/schemas/SignatureVBAResponse' text/json: schema: $ref: '#/components/schemas/SignatureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Signatures summary: List Signature description: Lists all Signature operationId: ListSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SignatureListVBAResponse' application/json: schema: $ref: '#/components/schemas/SignatureListVBAResponse' text/json: schema: $ref: '#/components/schemas/SignatureListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/signatures/{signatureKey}': get: tags: - Signatures summary: Get Signature description: Gets Signature operationId: GetSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: signatureKey in: path description: Signature Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SignatureVBAResponse' application/json: schema: $ref: '#/components/schemas/SignatureVBAResponse' text/json: schema: $ref: '#/components/schemas/SignatureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Signatures summary: Update Signature description: Updates a specific Signature. operationId: UpdateSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: signatureKey in: path description: Signature Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Signature' text/json: schema: $ref: '#/components/schemas/Signature' application/*+json: schema: $ref: '#/components/schemas/Signature' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SignatureVBAResponse' application/json: schema: $ref: '#/components/schemas/SignatureVBAResponse' text/json: schema: $ref: '#/components/schemas/SignatureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Signatures summary: Delete Signature description: Deletes an Signature operationId: DeleteSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: signatureKey in: path description: Signature Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /signatures-batch: put: tags: - Signatures summary: Create or Update Batch Signature description: 'Create or Update multiple Signature at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSignature parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Signature' text/json: schema: type: array items: $ref: '#/components/schemas/Signature' application/*+json: schema: type: array items: $ref: '#/components/schemas/Signature' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /specialties: post: tags: - Specialty summary: Create Specialty description: Creates a new Specialty. operationId: CreateSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Specialty' text/json: schema: $ref: '#/components/schemas/Specialty' application/*+json: schema: $ref: '#/components/schemas/Specialty' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SpecialtyVBAResponse' application/json: schema: $ref: '#/components/schemas/SpecialtyVBAResponse' text/json: schema: $ref: '#/components/schemas/SpecialtyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Specialty summary: List Specialties description: List all Specialties operationId: ListSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SpecialtyListVBAResponse' application/json: schema: $ref: '#/components/schemas/SpecialtyListVBAResponse' text/json: schema: $ref: '#/components/schemas/SpecialtyListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/specialties/{specialtyCode}': get: tags: - Specialty summary: Get Specialty description: Gets Specialty operationId: GetSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: specialtyCode in: path description: Specialty Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SpecialtyVBAResponse' application/json: schema: $ref: '#/components/schemas/SpecialtyVBAResponse' text/json: schema: $ref: '#/components/schemas/SpecialtyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Specialty summary: Update Specialty description: Updates a specific Specialty. operationId: UpdateSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: specialtyCode in: path description: Specialty Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Specialty' text/json: schema: $ref: '#/components/schemas/Specialty' application/*+json: schema: $ref: '#/components/schemas/Specialty' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SpecialtyVBAResponse' application/json: schema: $ref: '#/components/schemas/SpecialtyVBAResponse' text/json: schema: $ref: '#/components/schemas/SpecialtyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Specialty summary: Delete Specialty description: Deletes an Specialty operationId: DeleteSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: specialtyCode in: path description: Specialty Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /specialties-batch: put: tags: - Specialty summary: Create or Update Batch Specialty description: Creates or Updates multiple Specialties operationId: CreateOrUpdateBatchSpecialty parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Specialty' text/json: schema: type: array items: $ref: '#/components/schemas/Specialty' application/*+json: schema: type: array items: $ref: '#/components/schemas/Specialty' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /sso-configs: post: tags: - Client Config summary: Create SSOConfig description: Creates a new SSOConfig operationId: CreateSSOConfig parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SSOConfig' text/json: schema: $ref: '#/components/schemas/SSOConfig' application/*+json: schema: $ref: '#/components/schemas/SSOConfig' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SSOConfigVBAResponse' application/json: schema: $ref: '#/components/schemas/SSOConfigVBAResponse' text/json: schema: $ref: '#/components/schemas/SSOConfigVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Client Config summary: List SSOConfig description: Lists all SSOConfig operationId: ListSSOConfig parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SSOConfigListVBAResponse' application/json: schema: $ref: '#/components/schemas/SSOConfigListVBAResponse' text/json: schema: $ref: '#/components/schemas/SSOConfigListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/sso-configs/{SSOConfig_ID}': get: tags: - Client Config summary: Get SSOConfig description: Gets SSOConfig operationId: GetSSOConfig parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SSOConfig_ID in: path description: SSOConfig ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SSOConfigVBAResponse' application/json: schema: $ref: '#/components/schemas/SSOConfigVBAResponse' text/json: schema: $ref: '#/components/schemas/SSOConfigVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Client Config summary: Update SSOConfig description: Updates a specific SSOConfig. operationId: UpdateSSOConfig parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SSOConfig_ID in: path description: SSOConfig ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SSOConfig' text/json: schema: $ref: '#/components/schemas/SSOConfig' application/*+json: schema: $ref: '#/components/schemas/SSOConfig' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SSOConfigVBAResponse' application/json: schema: $ref: '#/components/schemas/SSOConfigVBAResponse' text/json: schema: $ref: '#/components/schemas/SSOConfigVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Client Config summary: Delete SSOConfig description: Deletes an SSOConfig operationId: DeleteSSOConfig parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SSOConfig_ID in: path description: SSOConfig ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /sso-configs-batch: put: tags: - Client Config summary: Create or Update Batch SSOConfig description: 'Create or Update multiple SSOConfig at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSSOConfig parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SSOConfig' text/json: schema: type: array items: $ref: '#/components/schemas/SSOConfig' application/*+json: schema: type: array items: $ref: '#/components/schemas/SSOConfig' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /states: post: tags: - States summary: Create State description: Creates a new State operationId: CreateState parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/State' text/json: schema: $ref: '#/components/schemas/State' application/*+json: schema: $ref: '#/components/schemas/State' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StateVBAResponse' application/json: schema: $ref: '#/components/schemas/StateVBAResponse' text/json: schema: $ref: '#/components/schemas/StateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - States summary: List State description: 'Lists all State given a specific ' operationId: ListState parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StateListVBAResponse' application/json: schema: $ref: '#/components/schemas/StateListVBAResponse' text/json: schema: $ref: '#/components/schemas/StateListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/states/{stateAbbrev}': get: tags: - States summary: Get State description: Gets State operationId: GetState parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: stateAbbrev in: path description: State Abbreviation required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StateVBAResponse' application/json: schema: $ref: '#/components/schemas/StateVBAResponse' text/json: schema: $ref: '#/components/schemas/StateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - States summary: Update State description: Updates a specific State. operationId: UpdateState parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: stateAbbrev in: path description: State Abbreviation required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/State' text/json: schema: $ref: '#/components/schemas/State' application/*+json: schema: $ref: '#/components/schemas/State' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StateVBAResponse' application/json: schema: $ref: '#/components/schemas/StateVBAResponse' text/json: schema: $ref: '#/components/schemas/StateVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - States summary: Delete State description: Deletes an State operationId: DeleteState parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: stateAbbrev in: path description: State Abbreviation required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /states-batch: put: tags: - States summary: Create or Update Batch State description: 'Create or Update multiple State at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchState parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/State' text/json: schema: type: array items: $ref: '#/components/schemas/State' application/*+json: schema: type: array items: $ref: '#/components/schemas/State' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /state-interests: post: tags: - State Interest summary: Create StateInterest description: Creates a new StateInterest operationId: CreateStateInterest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/StateInterest' text/json: schema: $ref: '#/components/schemas/StateInterest' application/*+json: schema: $ref: '#/components/schemas/StateInterest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StateInterestVBAResponse' application/json: schema: $ref: '#/components/schemas/StateInterestVBAResponse' text/json: schema: $ref: '#/components/schemas/StateInterestVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - State Interest summary: List StateInterest description: Lists all StateInterest operationId: ListStateInterest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StateInterestListVBAResponse' application/json: schema: $ref: '#/components/schemas/StateInterestListVBAResponse' text/json: schema: $ref: '#/components/schemas/StateInterestListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/state-interests/{stateInterestKey}': get: tags: - State Interest summary: Get StateInterest description: Gets StateInterest operationId: GetStateInterest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: stateInterestKey in: path description: StateInterest Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StateInterestVBAResponse' application/json: schema: $ref: '#/components/schemas/StateInterestVBAResponse' text/json: schema: $ref: '#/components/schemas/StateInterestVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - State Interest summary: Update StateInterest description: Updates a specific StateInterest. operationId: UpdateStateInterest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: stateInterestKey in: path description: StateInterest Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/StateInterest' text/json: schema: $ref: '#/components/schemas/StateInterest' application/*+json: schema: $ref: '#/components/schemas/StateInterest' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StateInterestVBAResponse' application/json: schema: $ref: '#/components/schemas/StateInterestVBAResponse' text/json: schema: $ref: '#/components/schemas/StateInterestVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - State Interest summary: Delete StateInterest description: Deletes an StateInterest operationId: DeleteStateInterest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: stateInterestKey in: path description: StateInterest Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /state-interests-batch: put: tags: - State Interest summary: Create or Update Batch StateInterest description: 'Create or Update multiple StateInterest at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchStateInterest parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/StateInterest' text/json: schema: type: array items: $ref: '#/components/schemas/StateInterest' application/*+json: schema: type: array items: $ref: '#/components/schemas/StateInterest' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /state-procedure-code-taxes: post: tags: - State Procedure Code Taxes summary: Create StateProcedureCodeTax description: Creates a new StateProcedureCodeTax operationId: CreateStateProcedureCodeTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/StateProcedureCodeTax' text/json: schema: $ref: '#/components/schemas/StateProcedureCodeTax' application/*+json: schema: $ref: '#/components/schemas/StateProcedureCodeTax' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StateProcedureCodeTaxVBAResponse' application/json: schema: $ref: '#/components/schemas/StateProcedureCodeTaxVBAResponse' text/json: schema: $ref: '#/components/schemas/StateProcedureCodeTaxVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - State Procedure Code Taxes summary: List StateProcedureCodeTax description: Lists all StateProcedureCodeTax operationId: ListStateProcedureCodeTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StateProcedureCodeTaxListVBAResponse' application/json: schema: $ref: '#/components/schemas/StateProcedureCodeTaxListVBAResponse' text/json: schema: $ref: '#/components/schemas/StateProcedureCodeTaxListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/state-procedure-code-taxes/{state}/{procedureCode}': get: tags: - State Procedure Code Taxes summary: Get StateProcedureCodeTax description: Gets StateProcedureCodeTax operationId: GetStateProcedureCodeTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: state in: path description: State required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StateProcedureCodeTaxVBAResponse' application/json: schema: $ref: '#/components/schemas/StateProcedureCodeTaxVBAResponse' text/json: schema: $ref: '#/components/schemas/StateProcedureCodeTaxVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - State Procedure Code Taxes summary: Update StateProcedureCodeTax description: Updates a specific StateProcedureCodeTax. operationId: UpdateStateProcedureCodeTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: state in: path description: State required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/StateProcedureCodeTax' text/json: schema: $ref: '#/components/schemas/StateProcedureCodeTax' application/*+json: schema: $ref: '#/components/schemas/StateProcedureCodeTax' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StateProcedureCodeTaxVBAResponse' application/json: schema: $ref: '#/components/schemas/StateProcedureCodeTaxVBAResponse' text/json: schema: $ref: '#/components/schemas/StateProcedureCodeTaxVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - State Procedure Code Taxes summary: Delete StateProcedureCodeTax description: Deletes an StateProcedureCodeTax operationId: DeleteStateProcedureCodeTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: state in: path description: State required: true schema: type: string - name: procedureCode in: path description: Procedure Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /state-procedure-code-taxes-batch: put: tags: - State Procedure Code Taxes summary: Create or Update Batch StateProcedureCodeTax description: 'Create or Update multiple StateProcedureCodeTax at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchStateProcedureCodeTax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/StateProcedureCodeTax' text/json: schema: type: array items: $ref: '#/components/schemas/StateProcedureCodeTax' application/*+json: schema: type: array items: $ref: '#/components/schemas/StateProcedureCodeTax' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /benefit-levels: get: tags: - Benefits summary: List Benefit Levels description: 'List of all Benefit Levels with Key, Display and Description' operationId: ListBenefitLevels parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /benefit-plan-maximum-types: get: tags: - Benefits summary: List Benefit Plan Maximum Types description: List of all Benefit Plan Maximum Types operationId: ListBenefitPlanMaximumTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /benefit-plan-maximum-per-types: get: tags: - Benefits summary: List Benefit Plan Maximum Per Types description: List of all Benefit Plan Maximum Per Types operationId: ListBenefitPlanMaximumPerTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /benefit-plan-dental-designation-types: get: tags: - Benefits summary: List Benefit Plan Dental Designation Types description: List of all Benefit Plan Dental Designation Types operationId: ListBenefitPlanDentalDesignationTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /benefit-plan-maximum-network-types: get: tags: - Benefits summary: List Benefit Plan Maximum Network Types description: List of all Benefit Plan Maximum Network Types operationId: ListBenefitPlanMaximumNetworkTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /benefit-plan-maximum-coverage-types: get: tags: - Benefits summary: List Benefit Plan Maximum Scope Types description: List of all Benefit Plan Maximum Coverage Types operationId: ListBenefitPlanMaximumCoverageTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /benefit-rate-types: get: tags: - Benefits summary: List Benefit Rate Types description: List all Benefit Rate Types operationId: ListBenefitRateTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /benefit-rate-max-types: get: tags: - Benefits summary: List Benefit Rate Max Types description: List all Benefit Rate Max Types operationId: ListBenefitRateMaxTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /oop-types: get: tags: - Benefits summary: List Out of Pocket (OOP) Types description: List all Out of Pocket (OOP) Type key/value pairings. operationId: ListOutOfPocketTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /oop-calculations: get: tags: - Benefits summary: List Out of Pocket (OOP) Calculations description: List all Out of Pocket (OOP) Calculation key/value pairings. operationId: ListOutOfPocketCalculations parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /premium-rate-distribution-types: get: tags: - Premium Rate Distribution Types summary: List Premium Rate Distribution Types description: List Premium Rate Distribution Types operationId: ListPremiumRateDistributionTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /plan-benefit-amount-types: get: tags: - Benefits summary: List Plan Benefit Amount Types description: List Plan Benefit Amount Types operationId: ListPlanBenefitAmountTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /plan-benefit-co-pay-per-types: get: tags: - Benefits summary: List Plan Benefit Co-Pay Per Types description: List Plan Benefit Co-Pay Per Types operationId: ListPlanBenefitCoPayPerTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /automation-types: get: tags: - Report Static Lists summary: List Automation Types description: 'List of all Automation Types with Key, Display and Description' operationId: ListAutomationTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /automation-statuses: get: tags: - Report Static Lists summary: List Automation Statuses description: 'List of all Automation Statuses with Key, Display and Description' operationId: ListAutomationStatuses parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/enrollments': post: tags: - Subscriber Enrollments summary: Create SubEnrollment description: Creates a new SubEnrollment operationId: CreateSubEnrollment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubEnrollment' text/json: schema: $ref: '#/components/schemas/SubEnrollment' application/*+json: schema: $ref: '#/components/schemas/SubEnrollment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubEnrollmentVBAResponse' application/json: schema: $ref: '#/components/schemas/SubEnrollmentVBAResponse' text/json: schema: $ref: '#/components/schemas/SubEnrollmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Enrollments summary: List SubEnrollment description: Lists all SubEnrollment for the given subscriberID operationId: ListSubEnrollment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubEnrollmentListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubEnrollmentListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubEnrollmentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}': get: tags: - Subscriber Enrollments summary: Get SubEnrollment description: 'Gets a SubEnrollment for the given subscriberID, groupID, divisionID, groupCoverageStart, and startDate' operationId: GetSubEnrollment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubEnrollmentVBAResponse' application/json: schema: $ref: '#/components/schemas/SubEnrollmentVBAResponse' text/json: schema: $ref: '#/components/schemas/SubEnrollmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Enrollments summary: Update SubEnrollment description: 'Updates a SubEnrollment with the given subscriberID, groupID, divisionID, groupCoverageStart, and startDate' operationId: UpdateSubEnrollment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/SubEnrollment' text/json: schema: $ref: '#/components/schemas/SubEnrollment' application/*+json: schema: $ref: '#/components/schemas/SubEnrollment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubEnrollmentVBAResponse' application/json: schema: $ref: '#/components/schemas/SubEnrollmentVBAResponse' text/json: schema: $ref: '#/components/schemas/SubEnrollmentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Enrollments summary: Delete SubEnrollment description: 'Deletes a SubEnrollment with the given subscriberID, groupID, divisionID, groupCoverageStart, and startDate' operationId: DeleteSubEnrollment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/enrollments-batch': put: tags: - Subscriber Enrollments summary: Create or Update Batch SubEnrollment description: 'Create or Update multiple SubEnrollment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubEnrollment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubEnrollment' text/json: schema: type: array items: $ref: '#/components/schemas/SubEnrollment' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubEnrollment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/set-paid-through': post: tags: - Subscriber Enrollments summary: Set SubEnrollment Paid Through description: Sets the Paid Through value on the Subenrollment based on existing Premium Billing paid invoices. operationId: SubEnrollmentSetPaidThrough parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string responses: '202': description: Accepted '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans': post: tags: - Subscriber Enrollment Plans summary: Create SubEnrollmentPlan description: Creates a new SubEnrollmentPlan operationId: CreateSubEnrollmentPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/SubEnrollmentPlan' text/json: schema: $ref: '#/components/schemas/SubEnrollmentPlan' application/*+json: schema: $ref: '#/components/schemas/SubEnrollmentPlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubEnrollmentPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/SubEnrollmentPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/SubEnrollmentPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Enrollment Plans summary: List SubEnrollmentPlan description: 'Lists all SubEnrollmentPlan for the given Subscriber, Group, Division and Enrollment' operationId: ListSubEnrollmentPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubEnrollmentPlanListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubEnrollmentPlanListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubEnrollmentPlanListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/plans': get: tags: - Subscriber Enrollment Plans summary: List Subscriber SubEnrollmentPlans description: Lists all SubEnrollmentPlans for the given Subscriber operationId: ListSubscriberSubEnrollmentPlans parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}': get: tags: - Subscriber Enrollment Plans summary: Get SubEnrollmentPlan description: Gets SubEnrollmentPlan operationId: GetSubEnrollmentPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubEnrollmentPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/SubEnrollmentPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/SubEnrollmentPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Enrollment Plans summary: Update SubEnrollmentPlan description: Updates a specific SubEnrollmentPlan. operationId: UpdateSubEnrollmentPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/SubEnrollmentPlan' text/json: schema: $ref: '#/components/schemas/SubEnrollmentPlan' application/*+json: schema: $ref: '#/components/schemas/SubEnrollmentPlan' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubEnrollmentPlanVBAResponse' application/json: schema: $ref: '#/components/schemas/SubEnrollmentPlanVBAResponse' text/json: schema: $ref: '#/components/schemas/SubEnrollmentPlanVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Enrollment Plans summary: Delete SubEnrollmentPlan description: Deletes an SubEnrollmentPlan operationId: DeleteSubEnrollmentPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans-batch': put: tags: - Subscriber Enrollment Plans summary: Create or Update Batch SubEnrollmentPlan description: 'Create or Update multiple SubEnrollmentPlan at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubEnrollmentPlan parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubEnrollmentPlan' text/json: schema: type: array items: $ref: '#/components/schemas/SubEnrollmentPlan' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubEnrollmentPlan' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders': post: tags: - Subscriber Enrollment Plan Riders summary: Create SubEnrollmentRider description: Creates a new SubEnrollmentRider operationId: CreateSubEnrollmentRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/SubEnrollmentRider' text/json: schema: $ref: '#/components/schemas/SubEnrollmentRider' application/*+json: schema: $ref: '#/components/schemas/SubEnrollmentRider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubEnrollmentRiderVBAResponse' application/json: schema: $ref: '#/components/schemas/SubEnrollmentRiderVBAResponse' text/json: schema: $ref: '#/components/schemas/SubEnrollmentRiderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Enrollment Plan Riders summary: List SubEnrollmentRider description: Lists all SubEnrollmentRider for the given subscriberID and groupID and divisionID and groupCoverageStart and startDate and planID and planStart operationId: ListSubEnrollmentRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubEnrollmentRiderListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubEnrollmentRiderListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubEnrollmentRiderListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders/{benefitCode}/{fromDate}': get: tags: - Subscriber Enrollment Plan Riders summary: Get SubEnrollmentRider description: Gets SubEnrollmentRider operationId: GetSubEnrollmentRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: fromDate in: path description: From Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubEnrollmentRiderVBAResponse' application/json: schema: $ref: '#/components/schemas/SubEnrollmentRiderVBAResponse' text/json: schema: $ref: '#/components/schemas/SubEnrollmentRiderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Enrollment Plan Riders summary: Update SubEnrollmentRider description: Updates a specific SubEnrollmentRider. operationId: UpdateSubEnrollmentRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: fromDate in: path description: From Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/SubEnrollmentRider' text/json: schema: $ref: '#/components/schemas/SubEnrollmentRider' application/*+json: schema: $ref: '#/components/schemas/SubEnrollmentRider' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubEnrollmentRiderVBAResponse' application/json: schema: $ref: '#/components/schemas/SubEnrollmentRiderVBAResponse' text/json: schema: $ref: '#/components/schemas/SubEnrollmentRiderVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Enrollment Plan Riders summary: Delete SubEnrollmentRider description: Deletes an SubEnrollmentRider operationId: DeleteSubEnrollmentRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: fromDate in: path description: From Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders-batch': put: tags: - Subscriber Enrollment Plan Riders summary: Create or Update Batch SubEnrollmentRider description: 'Create or Update multiple SubEnrollmentRider at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubEnrollmentRider parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: groupCoverageStart in: path description: Group Coverage Start required: true schema: type: string format: date-time - name: startDate in: path description: Start Date required: true schema: type: string format: date-time - name: planID in: path description: Plan ID required: true schema: type: string - name: planStart in: path description: Plan Start required: true schema: type: string format: date-time requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubEnrollmentRider' text/json: schema: type: array items: $ref: '#/components/schemas/SubEnrollmentRider' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubEnrollmentRider' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/benefits': get: tags: - Subscribers summary: List Subscriber Benefits description: List of all Benefits for the given Subscriber ID operationId: ListSubscriberBenefits parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/StringStaticOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/payment-methods': post: tags: - Subscriber Payment Methods summary: Create SubPaymentMethod description: Creates a new SubPaymentMethod operationId: CreateSubPaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubPaymentMethod' text/json: schema: $ref: '#/components/schemas/SubPaymentMethod' application/*+json: schema: $ref: '#/components/schemas/SubPaymentMethod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubPaymentMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/SubPaymentMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/SubPaymentMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Payment Methods summary: List SubPaymentMethod description: Lists all SubPaymentMethod for the given subscriberID operationId: ListSubPaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubPaymentMethodListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubPaymentMethodListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubPaymentMethodListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/payment-methods/{subPaymentMethodKey}': get: tags: - Subscriber Payment Methods summary: Get SubPaymentMethod description: Gets SubPaymentMethod operationId: GetSubPaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: subPaymentMethodKey in: path description: Sub Payment Method Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubPaymentMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/SubPaymentMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/SubPaymentMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Payment Methods summary: Update SubPaymentMethod description: Updates a specific SubPaymentMethod. operationId: UpdateSubPaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: subPaymentMethodKey in: path description: Sub Payment Method Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SubPaymentMethod' text/json: schema: $ref: '#/components/schemas/SubPaymentMethod' application/*+json: schema: $ref: '#/components/schemas/SubPaymentMethod' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubPaymentMethodVBAResponse' application/json: schema: $ref: '#/components/schemas/SubPaymentMethodVBAResponse' text/json: schema: $ref: '#/components/schemas/SubPaymentMethodVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Payment Methods summary: Delete SubPaymentMethod description: Deletes an SubPaymentMethod operationId: DeleteSubPaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: subPaymentMethodKey in: path description: Sub Payment Method Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/payment-methods-batch': put: tags: - Subscriber Payment Methods summary: Create or Update Batch SubPaymentMethod description: 'Create or Update multiple SubPaymentMethod at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubPaymentMethod parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubPaymentMethod' text/json: schema: type: array items: $ref: '#/components/schemas/SubPaymentMethod' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubPaymentMethod' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/accumulators': post: tags: - Subscriber Accumulators summary: Create SubscriberAccum description: Creates a new SubscriberAccum operationId: CreateSubscriberAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberAccum' text/json: schema: $ref: '#/components/schemas/SubscriberAccum' application/*+json: schema: $ref: '#/components/schemas/SubscriberAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Accumulators summary: List SubscriberAccum description: Lists all SubscriberAccum for the given subscriberID and groupID operationId: ListSubscriberAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberAccumListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberAccumListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberAccumListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/accumulators/{planYear}/{planType}/{benefitCode}': get: tags: - Subscriber Accumulators summary: Get SubscriberAccum description: Gets SubscriberAccum operationId: GetSubscriberAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Accumulators summary: Update SubscriberAccum description: Updates a specific SubscriberAccum. operationId: UpdateSubscriberAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberAccum' text/json: schema: $ref: '#/components/schemas/SubscriberAccum' application/*+json: schema: $ref: '#/components/schemas/SubscriberAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Accumulators summary: Delete SubscriberAccum description: Deletes an SubscriberAccum operationId: DeleteSubscriberAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/accumulators-batch': put: tags: - Subscriber Accumulators summary: Create or Update Batch SubscriberAccum description: 'Create or Update multiple SubscriberAccum at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberAccum' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberAccum' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberAccum' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes': post: tags: - Subscriber Flex summary: Create SubscriberFlex description: Creates a new SubscriberFlex operationId: CreateSubscriberFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberFlex' text/json: schema: $ref: '#/components/schemas/SubscriberFlex' application/*+json: schema: $ref: '#/components/schemas/SubscriberFlex' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberFlexVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberFlexVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberFlexVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Flex summary: List SubscriberFlex description: Lists all SubscriberFlex for the given subscriberID and groupID and planID operationId: ListSubscriberFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberFlexListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberFlexListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberFlexListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}': get: tags: - Subscriber Flex summary: Get SubscriberFlex description: Gets SubscriberFlex operationId: GetSubscriberFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: calendarYear in: path description: Calendar Year required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberFlexVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberFlexVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberFlexVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Flex summary: Update SubscriberFlex description: Updates a specific SubscriberFlex. operationId: UpdateSubscriberFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: calendarYear in: path description: Calendar Year required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberFlex' text/json: schema: $ref: '#/components/schemas/SubscriberFlex' application/*+json: schema: $ref: '#/components/schemas/SubscriberFlex' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberFlexVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberFlexVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberFlexVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Flex summary: Delete SubscriberFlex description: Deletes an SubscriberFlex operationId: DeleteSubscriberFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: calendarYear in: path description: Calendar Year required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes-batch': put: tags: - Subscriber Flex summary: Create or Update Batch SubscriberFlex description: 'Create or Update multiple SubscriberFlex at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberFlex parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberFlex' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberFlex' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberFlex' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}/exports': post: tags: - Subscriber Flex Exports summary: Create SubscriberFlexExported description: Creates a new SubscriberFlexExported operationId: CreateSubscriberFlexExported parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: calendarYear in: path description: Calendar Year required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberFlexExported' text/json: schema: $ref: '#/components/schemas/SubscriberFlexExported' application/*+json: schema: $ref: '#/components/schemas/SubscriberFlexExported' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberFlexExportedVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberFlexExportedVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberFlexExportedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Flex Exports summary: List SubscriberFlexExported description: Lists all SubscriberFlexExported for the given subscriberID and groupID and planID and calendarYear and effectiveDate operationId: ListSubscriberFlexExported parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: calendarYear in: path description: Calendar Year required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberFlexExportedListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberFlexExportedListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberFlexExportedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}/exports/{subscriberFlexExportedKey}': get: tags: - Subscriber Flex Exports summary: Get SubscriberFlexExported description: Gets SubscriberFlexExported operationId: GetSubscriberFlexExported parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: calendarYear in: path description: Calendar Year required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time - name: subscriberFlexExportedKey in: path description: SubscriberFlexExported Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberFlexExportedVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberFlexExportedVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberFlexExportedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Flex Exports summary: Update SubscriberFlexExported description: Updates a specific SubscriberFlexExported. operationId: UpdateSubscriberFlexExported parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: calendarYear in: path description: Calendar Year required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time - name: subscriberFlexExportedKey in: path description: SubscriberFlexExported Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberFlexExported' text/json: schema: $ref: '#/components/schemas/SubscriberFlexExported' application/*+json: schema: $ref: '#/components/schemas/SubscriberFlexExported' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberFlexExportedVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberFlexExportedVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberFlexExportedVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Flex Exports summary: Delete SubscriberFlexExported description: Deletes an SubscriberFlexExported operationId: DeleteSubscriberFlexExported parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: calendarYear in: path description: Calendar Year required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time - name: subscriberFlexExportedKey in: path description: SubscriberFlexExported Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}/exports-batch': put: tags: - Subscriber Flex Exports summary: Create or Update Batch SubscriberFlexExported description: 'Create or Update multiple SubscriberFlexExported at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberFlexExported parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: calendarYear in: path description: Calendar Year required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberFlexExported' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberFlexExported' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberFlexExported' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flex-payments': post: tags: - Subscriber Flex Payments summary: Create SubscriberFlexPayment description: Creates a new SubscriberFlexPayment operationId: CreateSubscriberFlexPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberFlexPayment' text/json: schema: $ref: '#/components/schemas/SubscriberFlexPayment' application/*+json: schema: $ref: '#/components/schemas/SubscriberFlexPayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberFlexPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberFlexPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberFlexPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Flex Payments summary: List SubscriberFlexPayment description: Lists all SubscriberFlexPayment for the given subscriberID and groupID and planID operationId: ListSubscriberFlexPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberFlexPaymentListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberFlexPaymentListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberFlexPaymentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flex-payments/{subscriberFlexPaymentKey}': get: tags: - Subscriber Flex Payments summary: Get SubscriberFlexPayment description: Gets SubscriberFlexPayment operationId: GetSubscriberFlexPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: subscriberFlexPaymentKey in: path description: SubscriberFlexPayment Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberFlexPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberFlexPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberFlexPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Flex Payments summary: Update SubscriberFlexPayment description: Updates a specific SubscriberFlexPayment. operationId: UpdateSubscriberFlexPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: subscriberFlexPaymentKey in: path description: SubscriberFlexPayment Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberFlexPayment' text/json: schema: $ref: '#/components/schemas/SubscriberFlexPayment' application/*+json: schema: $ref: '#/components/schemas/SubscriberFlexPayment' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberFlexPaymentVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberFlexPaymentVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberFlexPaymentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Flex Payments summary: Delete SubscriberFlexPayment description: Deletes an SubscriberFlexPayment operationId: DeleteSubscriberFlexPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: subscriberFlexPaymentKey in: path description: SubscriberFlexPayment Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flex-payments-batch': put: tags: - Subscriber Flex Payments summary: Create or Update Batch SubscriberFlexPayment description: 'Create or Update multiple SubscriberFlexPayment at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberFlexPayment parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberFlexPayment' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberFlexPayment' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberFlexPayment' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /subscriber-forfeiture-status: post: tags: - Subscriber Plan Policy Forfeitures summary: Create SubscriberForfeitureStatus description: Creates a new SubscriberForfeitureStatus operationId: CreateSubscriberForfeitureStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatus' text/json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatus' application/*+json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberForfeitureStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Plan Policy Forfeitures summary: List SubscriberForfeitureStatus description: 'Lists all SubscriberForfeitureStatus for the given filters: subscriberID and planID and benefitCode and policyNumber and forfeitureStatus and effectiveDate' operationId: ListSubscriberForfeitureStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: query description: Subscriber ID schema: type: string - name: planID in: query description: Plan ID schema: type: string - name: benefitCode in: query description: Benefit Code schema: type: string - name: policyNumber in: query description: Policy Number schema: type: string - name: forfeitureStatus in: query description: Forfeiture Status schema: type: string - name: effectiveDate in: query description: Effective Date schema: type: string format: date-time - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberForfeitureStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscriber-forfeiture-status/{subscriberID}/{planID}/{benefitCode}/{policyNumber}/{forfeitureStatus}/{effectiveDate}': get: tags: - Subscriber Plan Policy Forfeitures summary: Get SubscriberForfeitureStatus description: Gets SubscriberForfeitureStatus operationId: GetSubscriberForfeitureStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string - name: forfeitureStatus in: path description: Forfeiture Status required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberForfeitureStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Plan Policy Forfeitures summary: Update SubscriberForfeitureStatus description: Updates a specific SubscriberForfeitureStatus. operationId: UpdateSubscriberForfeitureStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string - name: forfeitureStatus in: path description: Forfeiture Status required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatus' text/json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatus' application/*+json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberForfeitureStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberForfeitureStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Plan Policy Forfeitures summary: Delete SubscriberForfeitureStatus description: Deletes an SubscriberForfeitureStatus operationId: DeleteSubscriberForfeitureStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string - name: forfeitureStatus in: path description: Forfeiture Status required: true schema: type: string - name: effectiveDate in: path description: Effective Date required: true schema: type: string format: date-time responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/id-codes': post: tags: - Subscriber ID Codes summary: Create SubscriberIDCode description: Creates a new SubscriberIDCode operationId: CreateSubscriberIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberIDCode' text/json: schema: $ref: '#/components/schemas/SubscriberIDCode' application/*+json: schema: $ref: '#/components/schemas/SubscriberIDCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberIDCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberIDCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberIDCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber ID Codes summary: List SubscriberIDCode description: Lists all SubscriberIDCode for the given subscriberID operationId: ListSubscriberIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberIDCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberIDCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberIDCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/id-codes-batch': put: tags: - Subscriber ID Codes summary: Create or Update Batch SubscriberIDCode description: 'Create or Update multiple SubscriberIDCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberIDCode' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberIDCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberIDCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/id-codes/{iDCode}': get: tags: - Subscriber ID Codes summary: Get SubscriberIDCode description: Gets SubscriberIDCode operationId: GetSubscriberIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: iDCode in: path description: ID Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberIDCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberIDCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberIDCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber ID Codes summary: Update SubscriberIDCode description: Updates a specific SubscriberIDCode. operationId: UpdateSubscriberIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: iDCode in: path description: ID Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberIDCode' text/json: schema: $ref: '#/components/schemas/SubscriberIDCode' application/*+json: schema: $ref: '#/components/schemas/SubscriberIDCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberIDCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberIDCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberIDCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber ID Codes summary: Delete SubscriberIDCode description: Deletes an SubscriberIDCode operationId: DeleteSubscriberIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: iDCode in: path description: ID Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{newSubscriberID}/id-codes-history': post: tags: - Subscriber ID Code History summary: Create SubscriberIDHistory description: Creates a new SubscriberIDHistory operationId: CreateSubscriberIDHistory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: newSubscriberID in: path description: New Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberIDHistory' text/json: schema: $ref: '#/components/schemas/SubscriberIDHistory' application/*+json: schema: $ref: '#/components/schemas/SubscriberIDHistory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberIDHistoryVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberIDHistoryVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberIDHistoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber ID Code History summary: List SubscriberIDHistory description: Lists all SubscriberIDHistory for the given newSubscriberID operationId: ListSubscriberIDHistory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: newSubscriberID in: path description: New Subscriber ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberIDHistoryListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberIDHistoryListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberIDHistoryListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{newSubscriberID}/id-codes-history-batch': put: tags: - Subscriber ID Code History summary: Create or Update Batch SubscriberIDHistory description: 'Create or Update multiple SubscriberIDHistory at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberIDHistory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: newSubscriberID in: path description: New Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberIDHistory' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberIDHistory' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberIDHistory' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{newSubscriberID}/id-codes-history/{changeID}': get: tags: - Subscriber ID Code History summary: Get SubscriberIDHistory description: Gets SubscriberIDHistory operationId: GetSubscriberIDHistory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: newSubscriberID in: path description: New Subscriber ID required: true schema: type: string - name: changeID in: path description: Change ID required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberIDHistoryVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberIDHistoryVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberIDHistoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber ID Code History summary: Update SubscriberIDHistory description: Updates a specific SubscriberIDHistory. operationId: UpdateSubscriberIDHistory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: newSubscriberID in: path description: New Subscriber ID required: true schema: type: string - name: changeID in: path description: Change ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberIDHistory' text/json: schema: $ref: '#/components/schemas/SubscriberIDHistory' application/*+json: schema: $ref: '#/components/schemas/SubscriberIDHistory' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberIDHistoryVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberIDHistoryVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberIDHistoryVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber ID Code History summary: Delete SubscriberIDHistory description: Deletes an SubscriberIDHistory operationId: DeleteSubscriberIDHistory parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: newSubscriberID in: path description: New Subscriber ID required: true schema: type: string - name: changeID in: path description: Change ID required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/plan-policies': post: tags: - Subscriber Plan Policies summary: Create SubscriberPlanPolicy description: Creates a new SubscriberPlanPolicy operationId: CreateSubscriberPlanPolicy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberPlanPolicy' text/json: schema: $ref: '#/components/schemas/SubscriberPlanPolicy' application/*+json: schema: $ref: '#/components/schemas/SubscriberPlanPolicy' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPlanPolicyVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPlanPolicyVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPlanPolicyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Plan Policies summary: List SubscriberPlanPolicy description: Lists all SubscriberPlanPolicy for the given subscriberID operationId: ListSubscriberPlanPolicy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPlanPolicyListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPlanPolicyListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPlanPolicyListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/plan-policies/{planID}/{benefitCode}/{policyNumber}': get: tags: - Subscriber Plan Policies summary: Get SubscriberPlanPolicy description: Gets SubscriberPlanPolicy operationId: GetSubscriberPlanPolicy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPlanPolicyVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPlanPolicyVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPlanPolicyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Plan Policies summary: Update SubscriberPlanPolicy description: Updates a specific SubscriberPlanPolicy. operationId: UpdateSubscriberPlanPolicy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberPlanPolicy' text/json: schema: $ref: '#/components/schemas/SubscriberPlanPolicy' application/*+json: schema: $ref: '#/components/schemas/SubscriberPlanPolicy' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPlanPolicyVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPlanPolicyVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPlanPolicyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Plan Policies summary: Delete SubscriberPlanPolicy description: Deletes an SubscriberPlanPolicy operationId: DeleteSubscriberPlanPolicy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/plan-policies-batch': put: tags: - Subscriber Plan Policies summary: Create or Update Batch SubscriberPlanPolicy description: 'Create or Update multiple SubscriberPlanPolicy at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberPlanPolicy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Ssubscriber ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberPlanPolicy' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberPlanPolicy' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberPlanPolicy' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/plans/{planID}/benefits/{benefitCode}/policies/{policyNumber}/statuses': post: tags: - Subscriber Plan Policy Statuses summary: Create SubscriberPolicyStatus description: Creates a new SubscriberPolicyStatus operationId: CreateSubscriberPolicyStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberPolicyStatus' text/json: schema: $ref: '#/components/schemas/SubscriberPolicyStatus' application/*+json: schema: $ref: '#/components/schemas/SubscriberPolicyStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPolicyStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPolicyStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPolicyStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Plan Policy Statuses summary: List SubscriberPolicyStatus description: Lists all SubscriberPolicyStatus for the given subscriberID and planID and benefitCode and policyNumber operationId: ListSubscriberPolicyStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPolicyStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPolicyStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPolicyStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/plans/{planID}/benefits/{benefitCode}/policies/{policyNumber}/statuses/{policyStatus}': get: tags: - Subscriber Plan Policy Statuses summary: Get SubscriberPolicyStatus description: Gets SubscriberPolicyStatus operationId: GetSubscriberPolicyStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string - name: policyStatus in: path description: Policy Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPolicyStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPolicyStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPolicyStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Plan Policy Statuses summary: Update SubscriberPolicyStatus description: Updates a specific SubscriberPolicyStatus. operationId: UpdateSubscriberPolicyStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string - name: policyStatus in: path description: Policy Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberPolicyStatus' text/json: schema: $ref: '#/components/schemas/SubscriberPolicyStatus' application/*+json: schema: $ref: '#/components/schemas/SubscriberPolicyStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPolicyStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPolicyStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPolicyStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Plan Policy Statuses summary: Delete SubscriberPolicyStatus description: Deletes an SubscriberPolicyStatus operationId: DeleteSubscriberPolicyStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string - name: policyStatus in: path description: Policy Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/plans/{planID}/benefits/{benefitCode}/policies/{policyNumber}/statuses-batch': put: tags: - Subscriber Plan Policy Statuses summary: Create or Update Batch SubscriberPolicyStatus description: 'Create or Update multiple SubscriberPolicyStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberPolicyStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: policyNumber in: path description: Policy Number required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberPolicyStatus' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberPolicyStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberPolicyStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/premium-rate-splits': post: tags: - Subscriber Premium Rate Splits summary: Create SubscriberPremRateSplit description: Creates a new SubscriberPremRateSplit operationId: CreateSubscriberPremRateSplit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberPremRateSplit' text/json: schema: $ref: '#/components/schemas/SubscriberPremRateSplit' application/*+json: schema: $ref: '#/components/schemas/SubscriberPremRateSplit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPremRateSplitVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPremRateSplitVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPremRateSplitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Premium Rate Splits summary: List SubscriberPremRateSplit description: Lists all SubscriberPremRateSplit for the given subscriberID operationId: ListSubscriberPremRateSplit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPremRateSplitListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPremRateSplitListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPremRateSplitListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/premium-rate-splits-batch': put: tags: - Subscriber Premium Rate Splits summary: Create or Update Batch SubscriberPremRateSplit description: 'Create or Update multiple SubscriberPremRateSplit at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberPremRateSplit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberPremRateSplit' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberPremRateSplit' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberPremRateSplit' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/premium-rate-splits/{subscriberPremRateSplitKey}': get: tags: - Subscriber Premium Rate Splits summary: Get SubscriberPremRateSplit description: Gets SubscriberPremRateSplit operationId: GetSubscriberPremRateSplit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: subscriberPremRateSplitKey in: path description: SubscriberPremRateSplit Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPremRateSplitVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPremRateSplitVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPremRateSplitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Premium Rate Splits summary: Update SubscriberPremRateSplit description: Updates a specific SubscriberPremRateSplit. operationId: UpdateSubscriberPremRateSplit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: subscriberPremRateSplitKey in: path description: SubscriberPremRateSplit Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberPremRateSplit' text/json: schema: $ref: '#/components/schemas/SubscriberPremRateSplit' application/*+json: schema: $ref: '#/components/schemas/SubscriberPremRateSplit' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPremRateSplitVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPremRateSplitVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPremRateSplitVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Premium Rate Splits summary: Delete SubscriberPremRateSplit description: Deletes an SubscriberPremRateSplit operationId: DeleteSubscriberPremRateSplit parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: subscriberPremRateSplitKey in: path description: SubscriberPremRateSplit Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/prior-accumulators': post: tags: - Subscriber Prior Accumulators summary: Create SubscriberPriorAccum description: Creates a new SubscriberPriorAccum operationId: CreateSubscriberPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberPriorAccum' text/json: schema: $ref: '#/components/schemas/SubscriberPriorAccum' application/*+json: schema: $ref: '#/components/schemas/SubscriberPriorAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPriorAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPriorAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPriorAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Prior Accumulators summary: List SubscriberPriorAccum description: Lists all SubscriberPriorAccum for the given subscriberID and groupID operationId: ListSubscriberPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPriorAccumListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPriorAccumListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPriorAccumListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/prior-accumulators/{planYear}/{planType}/{benefitCode}': get: tags: - Subscriber Prior Accumulators summary: Get SubscriberPriorAccum description: Gets SubscriberPriorAccum operationId: GetSubscriberPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPriorAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPriorAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPriorAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Prior Accumulators summary: Update SubscriberPriorAccum description: Updates a specific SubscriberPriorAccum. operationId: UpdateSubscriberPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberPriorAccum' text/json: schema: $ref: '#/components/schemas/SubscriberPriorAccum' application/*+json: schema: $ref: '#/components/schemas/SubscriberPriorAccum' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberPriorAccumVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberPriorAccumVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberPriorAccumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Prior Accumulators summary: Delete SubscriberPriorAccum description: Deletes an SubscriberPriorAccum operationId: DeleteSubscriberPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planYear in: path description: Plan Year required: true schema: type: string - name: planType in: path description: Plan Type required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/groups/{groupID}/prior-accumulators-batch': put: tags: - Subscriber Prior Accumulators summary: Create or Update Batch SubscriberPriorAccum description: 'Create or Update multiple SubscriberPriorAccum at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberPriorAccum parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberPriorAccum' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberPriorAccum' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberPriorAccum' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/subscriber-reimbursements': post: tags: - Group Subscriber Reimbursements summary: Create SubscriberReimbursement description: Creates a new SubscriberReimbursement operationId: CreateSubscriberReimbursement parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberReimbursement' text/json: schema: $ref: '#/components/schemas/SubscriberReimbursement' application/*+json: schema: $ref: '#/components/schemas/SubscriberReimbursement' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberReimbursementVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberReimbursementVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberReimbursementVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Group Subscriber Reimbursements summary: List SubscriberReimbursement description: Lists all SubscriberReimbursement for the given groupID and planID and benefitCode and maxID operationId: ListSubscriberReimbursement parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberReimbursementListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberReimbursementListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberReimbursementListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/subscriber-reimbursements/{subscriberReimbursementKey}': get: tags: - Group Subscriber Reimbursements summary: Get SubscriberReimbursement description: Gets SubscriberReimbursement operationId: GetSubscriberReimbursement parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string - name: subscriberReimbursementKey in: path description: SubscriberReimbursement Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberReimbursementVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberReimbursementVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberReimbursementVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Group Subscriber Reimbursements summary: Update SubscriberReimbursement description: Updates a specific SubscriberReimbursement. operationId: UpdateSubscriberReimbursement parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string - name: subscriberReimbursementKey in: path description: SubscriberReimbursement Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberReimbursement' text/json: schema: $ref: '#/components/schemas/SubscriberReimbursement' application/*+json: schema: $ref: '#/components/schemas/SubscriberReimbursement' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberReimbursementVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberReimbursementVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberReimbursementVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Group Subscriber Reimbursements summary: Delete SubscriberReimbursement description: Deletes an SubscriberReimbursement operationId: DeleteSubscriberReimbursement parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string - name: subscriberReimbursementKey in: path description: SubscriberReimbursement Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/groups/{groupID}/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/subscriber-reimbursements-batch': put: tags: - Group Subscriber Reimbursements summary: Create or Update Batch SubscriberReimbursement description: 'Create or Update multiple SubscriberReimbursement at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberReimbursement parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: benefitCode in: path description: Benefit Code required: true schema: type: string - name: maxID in: path description: Max ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberReimbursement' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberReimbursement' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberReimbursement' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /subscribers: post: tags: - Subscribers summary: Create Subscribers description: Creates a new Subscribers operationId: CreateSubscribers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Subscribers' text/json: schema: $ref: '#/components/schemas/Subscribers' application/*+json: schema: $ref: '#/components/schemas/Subscribers' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscribersVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscribersVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscribersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscribers summary: List Subscribers description: Lists all Subscribers operationId: ListSubscribers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscribersListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscribersListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscribersListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /active-subscribers: get: tags: - Subscribers summary: List Active Subscribers for a Groupd & Division description: 'Lists all Subscribers for the given Group & Division. If division is omitted, all divisions will be included. Active is defined by a plan start date <= today and plan end date >= today.' operationId: ListActiveSubscribers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupId in: query description: Group ID required: true schema: type: string - name: divisionId in: query description: Division ID schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ActiveSubscriberListVBAResponse' application/json: schema: $ref: '#/components/schemas/ActiveSubscriberListVBAResponse' text/json: schema: $ref: '#/components/schemas/ActiveSubscriberListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}': get: tags: - Subscribers summary: Get Subscribers description: Gets Subscribers operationId: GetSubscribers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscribersVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscribersVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscribersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscribers summary: Update Subscribers description: Updates a specific Subscribers. operationId: UpdateSubscribers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Subscribers' text/json: schema: $ref: '#/components/schemas/Subscribers' application/*+json: schema: $ref: '#/components/schemas/Subscribers' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscribersVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscribersVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscribersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscribers summary: Delete Subscribers description: Deletes an Subscribers operationId: DeleteSubscribers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /subscribers-batch: put: tags: - Subscribers summary: Create or Update Batch Subscribers description: 'Create or Update multiple Subscribers at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscribers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Subscribers' text/json: schema: type: array items: $ref: '#/components/schemas/Subscribers' application/*+json: schema: type: array items: $ref: '#/components/schemas/Subscribers' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /subscribers-generate-id: get: tags: - Subscribers summary: Get Unique Subscriber ID description: Get a unique Subscriber ID you can use for creating a new Subscriber or changing an existing Subscirbers ID operationId: GenerateSubscriberID parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /subscriber-sponsors: post: tags: - Subscriber Sponsors summary: Create SubscriberSponsor description: Creates a new SubscriberSponsor operationId: CreateSubscriberSponsor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberSponsor' text/json: schema: $ref: '#/components/schemas/SubscriberSponsor' application/*+json: schema: $ref: '#/components/schemas/SubscriberSponsor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberSponsorVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberSponsorVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberSponsorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Sponsors summary: List SubscriberSponsor description: Lists all SubscriberSponsor operationId: ListSubscriberSponsor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberSponsorListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberSponsorListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberSponsorListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscriber-sponsors/{SubscriberSponsor_Key}': get: tags: - Subscriber Sponsors summary: Get SubscriberSponsor description: Gets SubscriberSponsor operationId: GetSubscriberSponsor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SubscriberSponsor_Key in: path description: SubscriberSponsor Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberSponsorVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberSponsorVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberSponsorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Sponsors summary: Update SubscriberSponsor description: Updates a specific SubscriberSponsor. operationId: UpdateSubscriberSponsor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SubscriberSponsor_Key in: path description: SubscriberSponsor Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberSponsor' text/json: schema: $ref: '#/components/schemas/SubscriberSponsor' application/*+json: schema: $ref: '#/components/schemas/SubscriberSponsor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberSponsorVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberSponsorVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberSponsorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Sponsors summary: Delete SubscriberSponsor description: Deletes an SubscriberSponsor operationId: DeleteSubscriberSponsor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: SubscriberSponsor_Key in: path description: SubscriberSponsor Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /subscriber-sponsors-batch: put: tags: - Subscriber Sponsors summary: Create or Update Batch SubscriberSponsor description: 'Create or Update multiple SubscriberSponsor at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberSponsor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberSponsor' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberSponsor' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberSponsor' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/waive-premiums': post: tags: - Subscriber Waive Premiums summary: Create SubscriberWaivePremium description: Creates a new SubscriberWaivePremium operationId: CreateSubscriberWaivePremium parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberWaivePremium' text/json: schema: $ref: '#/components/schemas/SubscriberWaivePremium' application/*+json: schema: $ref: '#/components/schemas/SubscriberWaivePremium' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberWaivePremiumVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberWaivePremiumVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberWaivePremiumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Waive Premiums summary: List SubscriberWaivePremium description: Lists all SubscriberWaivePremium for the given subscriberID operationId: ListSubscriberWaivePremium parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberWaivePremiumListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberWaivePremiumListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberWaivePremiumListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/waive-premiums/{subscriberWaivePremiumKey}': get: tags: - Subscriber Waive Premiums summary: Get SubscriberWaivePremium description: Gets SubscriberWaivePremium operationId: GetSubscriberWaivePremium parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: subscriberWaivePremiumKey in: path description: SubscriberWaivePremium Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberWaivePremiumVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberWaivePremiumVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberWaivePremiumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Waive Premiums summary: Update SubscriberWaivePremium description: Updates a specific SubscriberWaivePremium. operationId: UpdateSubscriberWaivePremium parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: subscriberWaivePremiumKey in: path description: SubscriberWaivePremium Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberWaivePremium' text/json: schema: $ref: '#/components/schemas/SubscriberWaivePremium' application/*+json: schema: $ref: '#/components/schemas/SubscriberWaivePremium' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberWaivePremiumVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberWaivePremiumVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberWaivePremiumVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Waive Premiums summary: Delete SubscriberWaivePremium description: Deletes an SubscriberWaivePremium operationId: DeleteSubscriberWaivePremium parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string - name: subscriberWaivePremiumKey in: path description: SubscriberWaivePremium Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{subscriberID}/waive-premiums-batch': put: tags: - Subscriber Waive Premiums summary: Create or Update Batch SubscriberWaivePremium description: 'Create or Update multiple SubscriberWaivePremium at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberWaivePremium parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: subscriberID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberWaivePremium' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberWaivePremium' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberWaivePremium' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{Subscriber_ID}/writing-agents': post: tags: - Subscriber Writing Agents summary: Create SubscriberWritingAgent description: Creates a new SubscriberWritingAgent operationId: CreateSubscriberWritingAgent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberWritingAgent' text/json: schema: $ref: '#/components/schemas/SubscriberWritingAgent' application/*+json: schema: $ref: '#/components/schemas/SubscriberWritingAgent' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberWritingAgentVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberWritingAgentVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberWritingAgentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Subscriber Writing Agents summary: List SubscriberWritingAgent description: Lists all SubscriberWritingAgent for the given Subscriber_ID operationId: ListSubscriberWritingAgent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberWritingAgentListVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberWritingAgentListVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberWritingAgentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{Subscriber_ID}/writing-agents/{SubscriberWritingAgent_Key}': get: tags: - Subscriber Writing Agents summary: Get SubscriberWritingAgent description: Gets SubscriberWritingAgent operationId: GetSubscriberWritingAgent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: SubscriberWritingAgent_Key in: path description: SubscriberWritingAgent Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberWritingAgentVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberWritingAgentVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberWritingAgentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Subscriber Writing Agents summary: Update SubscriberWritingAgent description: Updates a specific SubscriberWritingAgent. operationId: UpdateSubscriberWritingAgent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: SubscriberWritingAgent_Key in: path description: SubscriberWritingAgent Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriberWritingAgent' text/json: schema: $ref: '#/components/schemas/SubscriberWritingAgent' application/*+json: schema: $ref: '#/components/schemas/SubscriberWritingAgent' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SubscriberWritingAgentVBAResponse' application/json: schema: $ref: '#/components/schemas/SubscriberWritingAgentVBAResponse' text/json: schema: $ref: '#/components/schemas/SubscriberWritingAgentVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Subscriber Writing Agents summary: Delete SubscriberWritingAgent description: Deletes an SubscriberWritingAgent operationId: DeleteSubscriberWritingAgent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string - name: SubscriberWritingAgent_Key in: path description: SubscriberWritingAgent Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/subscribers/{Subscriber_ID}/writing-agents-batch': put: tags: - Subscriber Writing Agents summary: Create or Update Batch SubscriberWritingAgent description: 'Create or Update multiple SubscriberWritingAgent at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSubscriberWritingAgent parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Subscriber_ID in: path description: Subscriber ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberWritingAgent' text/json: schema: type: array items: $ref: '#/components/schemas/SubscriberWritingAgent' application/*+json: schema: type: array items: $ref: '#/components/schemas/SubscriberWritingAgent' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /suffixes: post: tags: - Suffix summary: Create Suffix description: Creates a new Suffix operationId: CreateSuffix parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Suffix' text/json: schema: $ref: '#/components/schemas/Suffix' application/*+json: schema: $ref: '#/components/schemas/Suffix' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuffixVBAResponse' application/json: schema: $ref: '#/components/schemas/SuffixVBAResponse' text/json: schema: $ref: '#/components/schemas/SuffixVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Suffix summary: List Suffix description: Lists all Suffix operationId: ListSuffixes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuffixListVBAResponse' application/json: schema: $ref: '#/components/schemas/SuffixListVBAResponse' text/json: schema: $ref: '#/components/schemas/SuffixListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/suffixes/{suffix1}': get: tags: - Suffix summary: Get Suffix description: Gets Suffix operationId: GetSuffix parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: suffix1 in: path description: Suffix1 required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuffixVBAResponse' application/json: schema: $ref: '#/components/schemas/SuffixVBAResponse' text/json: schema: $ref: '#/components/schemas/SuffixVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Suffix summary: Update Suffix description: Updates a specific Suffix operationId: UpdateSuffix parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: suffix1 in: path description: Suffix1 required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Suffix' text/json: schema: $ref: '#/components/schemas/Suffix' application/*+json: schema: $ref: '#/components/schemas/Suffix' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuffixVBAResponse' application/json: schema: $ref: '#/components/schemas/SuffixVBAResponse' text/json: schema: $ref: '#/components/schemas/SuffixVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Suffix summary: Delete Suffix description: Deletes an Suffix operationId: DeleteSuffix parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: suffix1 in: path description: Suffix1 required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /suffixes-batch: put: tags: - Suffix summary: Create or Update Batch Suffix description: 'Create or Update multiple Suffix at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSuffix parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Suffix' text/json: schema: type: array items: $ref: '#/components/schemas/Suffix' application/*+json: schema: type: array items: $ref: '#/components/schemas/Suffix' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /support/clients: get: tags: - Support summary: List All Clients description: Lists the clients operationId: ListClients parameters: - name: vbasoftware-database in: header description: Support Database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_ClientListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_ClientListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_ClientListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /support/client: get: tags: - Support summary: Get Client description: Gets the client details for the given client id and client code. operationId: GetClient parameters: - name: vbasoftware-database in: header description: Support Database required: true schema: type: string - name: clientId in: query description: Client ID required: true schema: type: string - name: clientCode in: query description: Client Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_ClientVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_ClientVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_ClientVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /support/client-users: post: tags: - Support summary: Create Support User in a client environment description: This endpoint allows you to create a support user and add them to a specific client's database. operationId: CreateSupportUser parameters: - name: vbasoftware-database in: header description: Support Database required: true schema: type: string - name: target-vbasoftware-client-id in: header description: Target Client ID required: true schema: type: string - name: target-vbasoftware-client-code in: header description: Target Client Code required: true schema: type: string - name: target-vbasoftware-database in: header description: Target Client Database required: true schema: type: string - name: userIdToClone in: query description: Client User ID to Clone required: true schema: type: string - name: makeAdmin in: query description: Make Administrator required: true schema: type: boolean default: false responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UsersVBAResponse' application/json: schema: $ref: '#/components/schemas/UsersVBAResponse' text/json: schema: $ref: '#/components/schemas/UsersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Support summary: List of all Users in a client environment description: '' operationId: ListClientUsers parameters: - name: vbasoftware-database in: header description: Support Database required: true schema: type: string - name: target-vbasoftware-client-id in: header description: Target Client ID required: true schema: type: string - name: target-vbasoftware-client-code in: header description: Target Client Code required: true schema: type: string - name: target-vbasoftware-database in: header description: Target Client Database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UsersListVBAResponse' application/json: schema: $ref: '#/components/schemas/UsersListVBAResponse' text/json: schema: $ref: '#/components/schemas/UsersListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /suspense-claims: post: tags: - Suspense Claims summary: Create SuspenseClaim description: Creates a new SuspenseClaim operationId: CreateSuspenseClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SuspenseClaim' text/json: schema: $ref: '#/components/schemas/SuspenseClaim' application/*+json: schema: $ref: '#/components/schemas/SuspenseClaim' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuspenseClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/SuspenseClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/SuspenseClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Suspense Claims summary: List SuspenseClaim description: Lists all SuspenseClaim operationId: ListSuspenseClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuspenseClaimListVBAResponse' application/json: schema: $ref: '#/components/schemas/SuspenseClaimListVBAResponse' text/json: schema: $ref: '#/components/schemas/SuspenseClaimListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/suspense-claims/{suspenseClaimKey}': get: tags: - Suspense Claims summary: Get SuspenseClaim description: Gets SuspenseClaim operationId: GetSuspenseClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: suspenseClaimKey in: path description: SuspenseClaim Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuspenseClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/SuspenseClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/SuspenseClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Suspense Claims summary: Update SuspenseClaim description: Updates a specific SuspenseClaim. operationId: UpdateSuspenseClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: suspenseClaimKey in: path description: SuspenseClaim Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SuspenseClaim' text/json: schema: $ref: '#/components/schemas/SuspenseClaim' application/*+json: schema: $ref: '#/components/schemas/SuspenseClaim' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuspenseClaimVBAResponse' application/json: schema: $ref: '#/components/schemas/SuspenseClaimVBAResponse' text/json: schema: $ref: '#/components/schemas/SuspenseClaimVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Suspense Claims summary: Delete SuspenseClaim description: Deletes an SuspenseClaim operationId: DeleteSuspenseClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: suspenseClaimKey in: path description: SuspenseClaim Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /suspense-claims-batch: put: tags: - Suspense Claims summary: Create or Update Batch SuspenseClaim description: 'Create or Update multiple SuspenseClaim at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSuspenseClaim parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SuspenseClaim' text/json: schema: type: array items: $ref: '#/components/schemas/SuspenseClaim' application/*+json: schema: type: array items: $ref: '#/components/schemas/SuspenseClaim' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /suspense-criterias: post: tags: - Suspense Criterias summary: Create SuspenseCriteria description: Creates a new SuspenseCriteria operationId: CreateSuspenseCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SuspenseCriteria' text/json: schema: $ref: '#/components/schemas/SuspenseCriteria' application/*+json: schema: $ref: '#/components/schemas/SuspenseCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuspenseCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/SuspenseCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/SuspenseCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Suspense Criterias summary: List SuspenseCriteria description: Lists all SuspenseCriteria operationId: ListSuspenseCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuspenseCriteriaListVBAResponse' application/json: schema: $ref: '#/components/schemas/SuspenseCriteriaListVBAResponse' text/json: schema: $ref: '#/components/schemas/SuspenseCriteriaListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/suspense-criterias/{suspenseCriteriaKey}': get: tags: - Suspense Criterias summary: Get SuspenseCriteria description: Gets SuspenseCriteria operationId: GetSuspenseCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: suspenseCriteriaKey in: path description: SuspenseCriteria Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuspenseCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/SuspenseCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/SuspenseCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Suspense Criterias summary: Update SuspenseCriteria description: Updates a specific SuspenseCriteria. operationId: UpdateSuspenseCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: suspenseCriteriaKey in: path description: SuspenseCriteria Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SuspenseCriteria' text/json: schema: $ref: '#/components/schemas/SuspenseCriteria' application/*+json: schema: $ref: '#/components/schemas/SuspenseCriteria' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuspenseCriteriaVBAResponse' application/json: schema: $ref: '#/components/schemas/SuspenseCriteriaVBAResponse' text/json: schema: $ref: '#/components/schemas/SuspenseCriteriaVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Suspense Criterias summary: Delete SuspenseCriteria description: Deletes an SuspenseCriteria operationId: DeleteSuspenseCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: suspenseCriteriaKey in: path description: SuspenseCriteria Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /suspense-criterias-batch: put: tags: - Suspense Criterias summary: Create or Update Batch SuspenseCriteria description: 'Create or Update multiple SuspenseCriteria at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSuspenseCriteria parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SuspenseCriteria' text/json: schema: type: array items: $ref: '#/components/schemas/SuspenseCriteria' application/*+json: schema: type: array items: $ref: '#/components/schemas/SuspenseCriteria' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /suspense-types: post: tags: - Suspense Types summary: Create SuspenseType description: Creates a new SuspenseType operationId: CreateSuspenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SuspenseType' text/json: schema: $ref: '#/components/schemas/SuspenseType' application/*+json: schema: $ref: '#/components/schemas/SuspenseType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuspenseTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/SuspenseTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/SuspenseTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Suspense Types summary: List SuspenseType description: Lists all SuspenseType operationId: ListSuspenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuspenseTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/SuspenseTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/SuspenseTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/suspense-types/{suspenseType}': get: tags: - Suspense Types summary: Get SuspenseType description: Gets SuspenseType operationId: GetSuspenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: suspenseType in: path description: Suspense Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuspenseTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/SuspenseTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/SuspenseTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Suspense Types summary: Update SuspenseType description: Updates a specific SuspenseType. operationId: UpdateSuspenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: suspenseType in: path description: Suspense Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SuspenseType' text/json: schema: $ref: '#/components/schemas/SuspenseType' application/*+json: schema: $ref: '#/components/schemas/SuspenseType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/SuspenseTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/SuspenseTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/SuspenseTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Suspense Types summary: Delete SuspenseType description: Deletes an SuspenseType operationId: DeleteSuspenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: suspenseType in: path description: Suspense Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /suspense-types-batch: put: tags: - Suspense Types summary: Create or Update Batch SuspenseType description: 'Create or Update multiple SuspenseType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchSuspenseType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SuspenseType' text/json: schema: type: array items: $ref: '#/components/schemas/SuspenseType' application/*+json: schema: type: array items: $ref: '#/components/schemas/SuspenseType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /system-logs: post: tags: - Logging summary: Creates a system log description: Creates a system log for a client VBA Application operationId: CreateSystemLog parameters: - name: vbasoftware-database in: header description: target database for this request required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SystemLogData' text/json: schema: $ref: '#/components/schemas/SystemLogData' application/*+json: schema: $ref: '#/components/schemas/SystemLogData' responses: '200': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /system-logs-batch: post: tags: - Logging summary: Creates multiple system log description: Creates multiple system logs for a client VBA Application operationId: CreateSystemLogBatch parameters: - name: vbasoftware-database in: header description: target database for this request required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SystemLogData' text/json: schema: type: array items: $ref: '#/components/schemas/SystemLogData' application/*+json: schema: type: array items: $ref: '#/components/schemas/SystemLogData' responses: '200': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tax-filing-statuses: post: tags: - Tax Filing Status summary: Create TaxFilingStatus description: Creates a new TaxFilingStatus operationId: CreateTaxFilingStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TaxFilingStatus' text/json: schema: $ref: '#/components/schemas/TaxFilingStatus' application/*+json: schema: $ref: '#/components/schemas/TaxFilingStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxFilingStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxFilingStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxFilingStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Tax Filing Status summary: List TaxFilingStatus description: Lists all TaxFilingStatus operationId: ListTaxFilingStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxFilingStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxFilingStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxFilingStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/tax-filing-statuses/{filingStatus}': get: tags: - Tax Filing Status summary: Get TaxFilingStatus description: Gets TaxFilingStatus operationId: GetTaxFilingStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: filingStatus in: path description: Filing Status required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxFilingStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxFilingStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxFilingStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Tax Filing Status summary: Update TaxFilingStatus description: Updates a specific TaxFilingStatus. operationId: UpdateTaxFilingStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: filingStatus in: path description: Filing Status required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/TaxFilingStatus' text/json: schema: $ref: '#/components/schemas/TaxFilingStatus' application/*+json: schema: $ref: '#/components/schemas/TaxFilingStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxFilingStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxFilingStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxFilingStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Tax Filing Status summary: Delete TaxFilingStatus description: Deletes an TaxFilingStatus operationId: DeleteTaxFilingStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: filingStatus in: path description: Filing Status required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tax-filing-statuses-batch: put: tags: - Tax Filing Status summary: Create or Update Batch TaxFilingStatus description: 'Create or Update multiple TaxFilingStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchTaxFilingStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TaxFilingStatus' text/json: schema: type: array items: $ref: '#/components/schemas/TaxFilingStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/TaxFilingStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /taxonomies: post: tags: - Taxonomy summary: Create Taxonomy description: Creates a new Taxonomy operationId: CreateTaxonomy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Taxonomy' text/json: schema: $ref: '#/components/schemas/Taxonomy' application/*+json: schema: $ref: '#/components/schemas/Taxonomy' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxonomyVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxonomyVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxonomyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Taxonomy summary: List Taxonomy description: 'Lists all Taxonomy given a specific ' operationId: ListTaxonomies parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxonomyListVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxonomyListVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxonomyListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/taxonomies/{taxonomyKey}': get: tags: - Taxonomy summary: Get Taxonomy description: Gets Taxonomy operationId: GetTaxonomy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: taxonomyKey in: path description: Taxonomy Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxonomyVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxonomyVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxonomyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Taxonomy summary: Update Taxonomy description: Updates a specific Taxonomy. operationId: UpdateTaxonomy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: taxonomyKey in: path description: Taxonomy Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Taxonomy' text/json: schema: $ref: '#/components/schemas/Taxonomy' application/*+json: schema: $ref: '#/components/schemas/Taxonomy' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxonomyVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxonomyVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxonomyVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Taxonomy summary: Delete Taxonomy description: Deletes an Taxonomy operationId: DeleteTaxonomy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: taxonomyKey in: path description: Taxonomy Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /taxonomies-batch: put: tags: - Taxonomy summary: Create or Update Batch Taxonomy description: 'Create or Update multiple Taxonomy at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchTaxonomy parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Taxonomy' text/json: schema: type: array items: $ref: '#/components/schemas/Taxonomy' application/*+json: schema: type: array items: $ref: '#/components/schemas/Taxonomy' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /taxonomy-groups: post: tags: - Taxonomy Groups summary: Create TaxonomyGroup description: Creates a new TaxonomyGroup operationId: CreateTaxonomyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TaxonomyGroup' text/json: schema: $ref: '#/components/schemas/TaxonomyGroup' application/*+json: schema: $ref: '#/components/schemas/TaxonomyGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxonomyGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxonomyGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxonomyGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Taxonomy Groups summary: List TaxonomyGroup description: 'Lists all TaxonomyGroup given a specific ' operationId: ListTaxonomyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxonomyGroupListVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxonomyGroupListVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxonomyGroupListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Taxonomy Groups summary: Create or Update Batch TaxonomyGroup description: 'Create or Update multiple TaxonomyGroup at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchTaxonomyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TaxonomyGroup' text/json: schema: type: array items: $ref: '#/components/schemas/TaxonomyGroup' application/*+json: schema: type: array items: $ref: '#/components/schemas/TaxonomyGroup' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/taxonomy-groups/{taxonomyGroupID}': get: tags: - Taxonomy Groups summary: Get TaxonomyGroup description: Gets TaxonomyGroup operationId: GetTaxonomyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: taxonomyGroupID in: path description: Taxonomy Group ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxonomyGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxonomyGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxonomyGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Taxonomy Groups summary: Update TaxonomyGroup description: Updates a specific TaxonomyGroup. operationId: UpdateTaxonomyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: taxonomyGroupID in: path description: Taxonomy Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TaxonomyGroup' text/json: schema: $ref: '#/components/schemas/TaxonomyGroup' application/*+json: schema: $ref: '#/components/schemas/TaxonomyGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxonomyGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxonomyGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxonomyGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Taxonomy Groups summary: Delete TaxonomyGroup description: Deletes an TaxonomyGroup operationId: DeleteTaxonomyGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: taxonomyGroupID in: path description: Taxonomy Group ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/taxonomy-groups/{taxonomyGroupID}/taxonomy-group-details': post: tags: - Taxonomy Group Details summary: Create TaxonomyGroupDetail description: Creates a new TaxonomyGroupDetail operationId: CreateTaxonomyGroupDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: taxonomyGroupID in: path description: Taxonomy Group ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TaxonomyGroupDetail' text/json: schema: $ref: '#/components/schemas/TaxonomyGroupDetail' application/*+json: schema: $ref: '#/components/schemas/TaxonomyGroupDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxonomyGroupDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxonomyGroupDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxonomyGroupDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Taxonomy Group Details summary: List TaxonomyGroupDetail description: Lists all TaxonomyGroupDetail given a specific taxonomyGroupID operationId: ListTaxonomyGroupDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: taxonomyGroupID in: path description: Taxonomy Group ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxonomyGroupDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxonomyGroupDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxonomyGroupDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/taxonomy-groups/{taxonomyGroupID}/taxonomy-group-details/{taxonomyGroupDetailKey}': get: tags: - Taxonomy Group Details summary: Get TaxonomyGroupDetail description: Gets TaxonomyGroupDetail operationId: GetTaxonomyGroupDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: taxonomyGroupID in: path description: Taxonomy Group ID required: true schema: type: string - name: taxonomyGroupDetailKey in: path description: TaxonomyGroupDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxonomyGroupDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxonomyGroupDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxonomyGroupDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Taxonomy Group Details summary: Update TaxonomyGroupDetail description: Updates a specific TaxonomyGroupDetail. operationId: UpdateTaxonomyGroupDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: taxonomyGroupID in: path description: Taxonomy Group ID required: true schema: type: string - name: taxonomyGroupDetailKey in: path description: TaxonomyGroupDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/TaxonomyGroupDetail' text/json: schema: $ref: '#/components/schemas/TaxonomyGroupDetail' application/*+json: schema: $ref: '#/components/schemas/TaxonomyGroupDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TaxonomyGroupDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/TaxonomyGroupDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/TaxonomyGroupDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Taxonomy Group Details summary: Delete TaxonomyGroupDetail description: Deletes an TaxonomyGroupDetail operationId: DeleteTaxonomyGroupDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: taxonomyGroupID in: path description: Taxonomy Group ID required: true schema: type: string - name: taxonomyGroupDetailKey in: path description: TaxonomyGroupDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/taxonomy-groups/{taxonomyGroupID}/taxonomy-group-details-batch': put: tags: - Taxonomy Group Details summary: Create or Update Batch TaxonomyGroupDetail description: 'Create or Update multiple TaxonomyGroupDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchTaxonomyGroupDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: taxonomyGroupID in: path description: Taxonomy Group ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TaxonomyGroupDetail' text/json: schema: type: array items: $ref: '#/components/schemas/TaxonomyGroupDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/TaxonomyGroupDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tiers: post: tags: - Tiers summary: Create Tier description: Creates a new Tier operationId: CreateTier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Tier' text/json: schema: $ref: '#/components/schemas/Tier' application/*+json: schema: $ref: '#/components/schemas/Tier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TierVBAResponse' application/json: schema: $ref: '#/components/schemas/TierVBAResponse' text/json: schema: $ref: '#/components/schemas/TierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Tiers summary: List Tier description: Lists all Tier operationId: ListTier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TierListVBAResponse' application/json: schema: $ref: '#/components/schemas/TierListVBAResponse' text/json: schema: $ref: '#/components/schemas/TierListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/tiers/{tier1}': get: tags: - Tiers summary: Get Tier description: Gets Tier operationId: GetTier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: tier1 in: path description: Tier1 required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TierVBAResponse' application/json: schema: $ref: '#/components/schemas/TierVBAResponse' text/json: schema: $ref: '#/components/schemas/TierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Tiers summary: Update Tier description: Updates a specific Tier. operationId: UpdateTier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: tier1 in: path description: Tier1 required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Tier' text/json: schema: $ref: '#/components/schemas/Tier' application/*+json: schema: $ref: '#/components/schemas/Tier' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TierVBAResponse' application/json: schema: $ref: '#/components/schemas/TierVBAResponse' text/json: schema: $ref: '#/components/schemas/TierVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Tiers summary: Delete Tier description: Deletes an Tier operationId: DeleteTier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: tier1 in: path description: Tier1 required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tiers-batch: put: tags: - Tiers summary: Create or Update Batch Tier description: 'Create or Update multiple Tier at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchTier parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Tier' text/json: schema: type: array items: $ref: '#/components/schemas/Tier' application/*+json: schema: type: array items: $ref: '#/components/schemas/Tier' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /timely-filings: post: tags: - Timely Filing summary: Create TimelyFiling description: Creates a new TimelyFiling operationId: CreateTimelyFiling parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TimelyFiling' text/json: schema: $ref: '#/components/schemas/TimelyFiling' application/*+json: schema: $ref: '#/components/schemas/TimelyFiling' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TimelyFilingVBAResponse' application/json: schema: $ref: '#/components/schemas/TimelyFilingVBAResponse' text/json: schema: $ref: '#/components/schemas/TimelyFilingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Timely Filing summary: List TimelyFiling description: Lists all TimelyFiling operationId: ListTimelyFiling parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TimelyFilingListVBAResponse' application/json: schema: $ref: '#/components/schemas/TimelyFilingListVBAResponse' text/json: schema: $ref: '#/components/schemas/TimelyFilingListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/timely-filings/{timelyFilingKey}': get: tags: - Timely Filing summary: Get TimelyFiling description: Gets TimelyFiling operationId: GetTimelyFiling parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: timelyFilingKey in: path description: TimelyFiling Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TimelyFilingVBAResponse' application/json: schema: $ref: '#/components/schemas/TimelyFilingVBAResponse' text/json: schema: $ref: '#/components/schemas/TimelyFilingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Timely Filing summary: Update TimelyFiling description: Updates a specific TimelyFiling. operationId: UpdateTimelyFiling parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: timelyFilingKey in: path description: TimelyFiling Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/TimelyFiling' text/json: schema: $ref: '#/components/schemas/TimelyFiling' application/*+json: schema: $ref: '#/components/schemas/TimelyFiling' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TimelyFilingVBAResponse' application/json: schema: $ref: '#/components/schemas/TimelyFilingVBAResponse' text/json: schema: $ref: '#/components/schemas/TimelyFilingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Timely Filing summary: Delete TimelyFiling description: Deletes an TimelyFiling operationId: DeleteTimelyFiling parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: timelyFilingKey in: path description: TimelyFiling Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /timely-filings-batch: put: tags: - Timely Filing summary: Create or Update Batch TimelyFiling description: 'Create or Update multiple TimelyFiling at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchTimelyFiling parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TimelyFiling' text/json: schema: type: array items: $ref: '#/components/schemas/TimelyFiling' application/*+json: schema: type: array items: $ref: '#/components/schemas/TimelyFiling' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tolerances: post: tags: - Tolerances summary: Create Tolerance description: Creates a new Tolerance operationId: CreateTolerance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Tolerance' text/json: schema: $ref: '#/components/schemas/Tolerance' application/*+json: schema: $ref: '#/components/schemas/Tolerance' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToleranceVBAResponse' application/json: schema: $ref: '#/components/schemas/ToleranceVBAResponse' text/json: schema: $ref: '#/components/schemas/ToleranceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Tolerances summary: List Tolerance description: Lists all Tolerance operationId: ListTolerance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToleranceListVBAResponse' application/json: schema: $ref: '#/components/schemas/ToleranceListVBAResponse' text/json: schema: $ref: '#/components/schemas/ToleranceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/tolerances/{Tolerance_Key}': get: tags: - Tolerances summary: Get Tolerance description: Gets Tolerance operationId: GetTolerance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Tolerance_Key in: path description: Tolerance Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToleranceVBAResponse' application/json: schema: $ref: '#/components/schemas/ToleranceVBAResponse' text/json: schema: $ref: '#/components/schemas/ToleranceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Tolerances summary: Update Tolerance description: Updates a specific Tolerance. operationId: UpdateTolerance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Tolerance_Key in: path description: Tolerance Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Tolerance' text/json: schema: $ref: '#/components/schemas/Tolerance' application/*+json: schema: $ref: '#/components/schemas/Tolerance' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToleranceVBAResponse' application/json: schema: $ref: '#/components/schemas/ToleranceVBAResponse' text/json: schema: $ref: '#/components/schemas/ToleranceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Tolerances summary: Delete Tolerance description: Deletes an Tolerance operationId: DeleteTolerance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: Tolerance_Key in: path description: Tolerance Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tolerances-batch: put: tags: - Tolerances summary: Create or Update Batch Tolerance description: 'Create or Update multiple Tolerance at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchTolerance parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Tolerance' text/json: schema: type: array items: $ref: '#/components/schemas/Tolerance' application/*+json: schema: type: array items: $ref: '#/components/schemas/Tolerance' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /teeth: post: tags: - Tooth summary: Create Tooth description: Creates a new Tooth operationId: CreateTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Tooth' text/json: schema: $ref: '#/components/schemas/Tooth' application/*+json: schema: $ref: '#/components/schemas/Tooth' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Tooth summary: List Tooth description: Lists all Tooth operationId: ListTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothListVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothListVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/teeth/{toothNumber}': get: tags: - Tooth summary: Get Tooth description: Gets Tooth operationId: GetTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: toothNumber in: path description: Tooth Number required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Tooth summary: Update Tooth description: Updates a specific Tooth. operationId: UpdateTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: toothNumber in: path description: Tooth Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Tooth' text/json: schema: $ref: '#/components/schemas/Tooth' application/*+json: schema: $ref: '#/components/schemas/Tooth' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Tooth summary: Delete Tooth description: Deletes an Tooth operationId: DeleteTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: toothNumber in: path description: Tooth Number required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /teeth-batch: put: tags: - Tooth summary: Create or Update Batch Tooth description: 'Create or Update multiple Tooth at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchTooth parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Tooth' text/json: schema: type: array items: $ref: '#/components/schemas/Tooth' application/*+json: schema: type: array items: $ref: '#/components/schemas/Tooth' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tooth-actions: post: tags: - Tooth Actions summary: Create ToothAction description: Creates a new ToothAction operationId: CreateToothAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ToothAction' text/json: schema: $ref: '#/components/schemas/ToothAction' application/*+json: schema: $ref: '#/components/schemas/ToothAction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothActionVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothActionVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothActionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Tooth Actions summary: List ToothAction description: Lists all ToothAction operationId: ListToothAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothActionListVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothActionListVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothActionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/tooth-actions/{toothAction}': get: tags: - Tooth Actions summary: Get ToothAction description: Gets ToothAction operationId: GetToothAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: toothAction in: path description: Tooth Action required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothActionVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothActionVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothActionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Tooth Actions summary: Update ToothAction description: Updates a specific ToothAction. operationId: UpdateToothAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: toothAction in: path description: Tooth Action required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ToothAction' text/json: schema: $ref: '#/components/schemas/ToothAction' application/*+json: schema: $ref: '#/components/schemas/ToothAction' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothActionVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothActionVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothActionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Tooth Actions summary: Delete ToothAction description: Deletes an ToothAction operationId: DeleteToothAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: toothAction in: path description: Tooth Action required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tooth-actions-batch: put: tags: - Tooth Actions summary: Create or Update Batch ToothAction description: 'Create or Update multiple ToothAction at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchToothAction parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ToothAction' text/json: schema: type: array items: $ref: '#/components/schemas/ToothAction' application/*+json: schema: type: array items: $ref: '#/components/schemas/ToothAction' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/tooth-charts/{chartType}/teeth/{toothNumber}': post: tags: - Tooth Charts summary: Create ToothChart description: Creates a new ToothChart operationId: CreateToothChart parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: chartType in: path description: Chart Type required: true schema: type: string - name: toothNumber in: path description: Tooth Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ToothChart' text/json: schema: $ref: '#/components/schemas/ToothChart' application/*+json: schema: $ref: '#/components/schemas/ToothChart' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothChartVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothChartVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothChartVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Tooth Charts summary: Get ToothChart description: Gets ToothChart operationId: GetToothChart parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: chartType in: path description: Chart Type required: true schema: type: string - name: toothNumber in: path description: Tooth Number required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothChartVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothChartVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothChartVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Tooth Charts summary: Update ToothChart description: Updates a specific ToothChart. operationId: UpdateToothChart parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: chartType in: path description: Chart Type required: true schema: type: string - name: toothNumber in: path description: Tooth Number required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ToothChart' text/json: schema: $ref: '#/components/schemas/ToothChart' application/*+json: schema: $ref: '#/components/schemas/ToothChart' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothChartVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothChartVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothChartVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Tooth Charts summary: Delete ToothChart description: Deletes an ToothChart operationId: DeleteToothChart parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: chartType in: path description: Chart Type required: true schema: type: string - name: toothNumber in: path description: Tooth Number required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/tooth-charts/{chartType}/teeth': get: tags: - Tooth Charts summary: List ToothChart description: Lists all ToothChart for the given chartType operationId: ListToothChart parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: chartType in: path description: Chart Type required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothChartListVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothChartListVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothChartListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/tooth-charts/{chartType}/teeth-batch': put: tags: - Tooth Charts summary: Create or Update Batch ToothChart description: 'Create or Update multiple ToothChart at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchToothChart parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: chartType in: path description: Chart Type required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ToothChart' text/json: schema: type: array items: $ref: '#/components/schemas/ToothChart' application/*+json: schema: type: array items: $ref: '#/components/schemas/ToothChart' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tooth-chart-types: post: tags: - Tooth Chart Types summary: Create ToothChartType description: Creates a new ToothChartType operationId: CreateToothChartType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ToothChartType' text/json: schema: $ref: '#/components/schemas/ToothChartType' application/*+json: schema: $ref: '#/components/schemas/ToothChartType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothChartTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothChartTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothChartTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Tooth Chart Types summary: List ToothChartType description: Lists all ToothChartType operationId: ListToothChartType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothChartTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothChartTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothChartTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/tooth-chart-types/{chartType}': get: tags: - Tooth Chart Types summary: Get ToothChartType description: Gets ToothChartType operationId: GetToothChartType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: chartType in: path description: Chart Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothChartTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothChartTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothChartTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Tooth Chart Types summary: Update ToothChartType description: Updates a specific ToothChartType. operationId: UpdateToothChartType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: chartType in: path description: Chart Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ToothChartType' text/json: schema: $ref: '#/components/schemas/ToothChartType' application/*+json: schema: $ref: '#/components/schemas/ToothChartType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothChartTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothChartTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothChartTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Tooth Chart Types summary: Delete ToothChartType description: Deletes an ToothChartType operationId: DeleteToothChartType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: chartType in: path description: Chart Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tooth-chart-types-batch: put: tags: - Tooth Chart Types summary: Create or Update Batch ToothChartType description: 'Create or Update multiple ToothChartType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchToothChartType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ToothChartType' text/json: schema: type: array items: $ref: '#/components/schemas/ToothChartType' application/*+json: schema: type: array items: $ref: '#/components/schemas/ToothChartType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tooth-procedures: post: tags: - Tooth Procedures summary: Create ToothProcedure description: Creates a new ToothProcedure operationId: CreateToothProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ToothProcedure' text/json: schema: $ref: '#/components/schemas/ToothProcedure' application/*+json: schema: $ref: '#/components/schemas/ToothProcedure' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Tooth Procedures summary: List ToothProcedure description: Lists all ToothProcedure operationId: ListToothProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothProcedureListVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothProcedureListVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothProcedureListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/tooth-procedures/{toothProcedureKey}': get: tags: - Tooth Procedures summary: Get ToothProcedure description: Gets ToothProcedure operationId: GetToothProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: toothProcedureKey in: path description: ToothProcedure Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Tooth Procedures summary: Update ToothProcedure description: Updates a specific ToothProcedure. operationId: UpdateToothProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: toothProcedureKey in: path description: ToothProcedure Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ToothProcedure' text/json: schema: $ref: '#/components/schemas/ToothProcedure' application/*+json: schema: $ref: '#/components/schemas/ToothProcedure' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Tooth Procedures summary: Delete ToothProcedure description: Deletes an ToothProcedure operationId: DeleteToothProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: toothProcedureKey in: path description: ToothProcedure Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tooth-procedures-batch: put: tags: - Tooth Procedures summary: Create or Update Batch ToothProcedure description: 'Create or Update multiple ToothProcedure at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchToothProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ToothProcedure' text/json: schema: type: array items: $ref: '#/components/schemas/ToothProcedure' application/*+json: schema: type: array items: $ref: '#/components/schemas/ToothProcedure' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tooth-quadrants: post: tags: - Tooth Quadrants summary: Create ToothQuadrant description: Creates a new ToothQuadrant operationId: CreateToothQuadrant parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ToothQuadrant' text/json: schema: $ref: '#/components/schemas/ToothQuadrant' application/*+json: schema: $ref: '#/components/schemas/ToothQuadrant' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothQuadrantVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothQuadrantVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothQuadrantVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Tooth Quadrants summary: List ToothQuadrant description: Lists all ToothQuadrant operationId: ListToothQuadrant parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothQuadrantListVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothQuadrantListVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothQuadrantListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/tooth-quadrants/{quadrant}': get: tags: - Tooth Quadrants summary: Get ToothQuadrant description: Gets ToothQuadrant operationId: GetToothQuadrant parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: quadrant in: path description: Quadrant required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothQuadrantVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothQuadrantVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothQuadrantVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Tooth Quadrants summary: Update ToothQuadrant description: Updates a specific ToothQuadrant. operationId: UpdateToothQuadrant parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: quadrant in: path description: Quadrant required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ToothQuadrant' text/json: schema: $ref: '#/components/schemas/ToothQuadrant' application/*+json: schema: $ref: '#/components/schemas/ToothQuadrant' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ToothQuadrantVBAResponse' application/json: schema: $ref: '#/components/schemas/ToothQuadrantVBAResponse' text/json: schema: $ref: '#/components/schemas/ToothQuadrantVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Tooth Quadrants summary: Delete ToothQuadrant description: Deletes an ToothQuadrant operationId: DeleteToothQuadrant parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: quadrant in: path description: Quadrant required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /tooth-quadrants-batch: put: tags: - Tooth Quadrants summary: Create or Update Batch ToothQuadrant description: 'Create or Update multiple ToothQuadrant at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchToothQuadrant parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ToothQuadrant' text/json: schema: type: array items: $ref: '#/components/schemas/ToothQuadrant' application/*+json: schema: type: array items: $ref: '#/components/schemas/ToothQuadrant' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /treatment-types: post: tags: - Treatment Types summary: Create TreatmentType description: Creates a new TreatmentType operationId: CreateTreatmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TreatmentType' text/json: schema: $ref: '#/components/schemas/TreatmentType' application/*+json: schema: $ref: '#/components/schemas/TreatmentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TreatmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/TreatmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/TreatmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Treatment Types summary: List TreatmentType description: Lists all TreatmentType operationId: ListTreatmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TreatmentTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/TreatmentTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/TreatmentTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/treatment-types/{treatmentType}': get: tags: - Treatment Types summary: Get TreatmentType description: Gets TreatmentType operationId: GetTreatmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: treatmentType in: path description: Treatment Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TreatmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/TreatmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/TreatmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Treatment Types summary: Update TreatmentType description: Updates a specific TreatmentType. operationId: UpdateTreatmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: treatmentType in: path description: Treatment Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TreatmentType' text/json: schema: $ref: '#/components/schemas/TreatmentType' application/*+json: schema: $ref: '#/components/schemas/TreatmentType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TreatmentTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/TreatmentTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/TreatmentTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Treatment Types summary: Delete TreatmentType description: Deletes an TreatmentType operationId: DeleteTreatmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: treatmentType in: path description: Treatment Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /treatment-types-batch: put: tags: - Treatment Types summary: Create or Update Batch TreatmentType description: 'Create or Update multiple TreatmentType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchTreatmentType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TreatmentType' text/json: schema: type: array items: $ref: '#/components/schemas/TreatmentType' application/*+json: schema: type: array items: $ref: '#/components/schemas/TreatmentType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /uc-networks: post: tags: - UC Network summary: Create UCNetwork description: Creates a new UCNetwork operationId: CreateUCNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UCNetwork' text/json: schema: $ref: '#/components/schemas/UCNetwork' application/*+json: schema: $ref: '#/components/schemas/UCNetwork' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UCNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/UCNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/UCNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - UC Network summary: List UCNetwork description: Lists all UCNetwork for the given groupID and divisionID and planID and state and feeSched operationId: ListUCNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: query description: Group ID schema: type: string - name: divisionID in: query description: Division ID schema: type: string - name: planID in: query description: Plan ID schema: type: string - name: state in: query description: State schema: type: string - name: feeSched in: query description: Fee Sched schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UCNetworkListVBAResponse' application/json: schema: $ref: '#/components/schemas/UCNetworkListVBAResponse' text/json: schema: $ref: '#/components/schemas/UCNetworkListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/uc-networks/{groupID}/{divisionID}/{planID}/{state}/{feeSched}': get: tags: - UC Network summary: Get UCNetwork description: Gets UCNetwork operationId: GetUCNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: state in: path description: State required: true schema: type: string - name: feeSched in: path description: Fee Sched required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UCNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/UCNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/UCNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - UC Network summary: Update UCNetwork description: Updates a specific UCNetwork. operationId: UpdateUCNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: state in: path description: State required: true schema: type: string - name: feeSched in: path description: Fee Sched required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UCNetwork' text/json: schema: $ref: '#/components/schemas/UCNetwork' application/*+json: schema: $ref: '#/components/schemas/UCNetwork' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UCNetworkVBAResponse' application/json: schema: $ref: '#/components/schemas/UCNetworkVBAResponse' text/json: schema: $ref: '#/components/schemas/UCNetworkVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - UC Network summary: Delete UCNetwork description: Deletes an UCNetwork operationId: DeleteUCNetwork parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: divisionID in: path description: Division ID required: true schema: type: string - name: planID in: path description: Plan ID required: true schema: type: string - name: state in: path description: State required: true schema: type: string - name: feeSched in: path description: Fee Sched required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /unit-type-conversions: post: tags: - Unit Type Conversions summary: Create UnitConversion description: Creates a new UnitConversion operationId: CreateUnitConversion parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UnitConversion' text/json: schema: $ref: '#/components/schemas/UnitConversion' application/*+json: schema: $ref: '#/components/schemas/UnitConversion' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UnitConversionVBAResponse' application/json: schema: $ref: '#/components/schemas/UnitConversionVBAResponse' text/json: schema: $ref: '#/components/schemas/UnitConversionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Unit Type Conversions summary: List UnitConversion description: Lists all UnitConversion operationId: ListUnitConversion parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UnitConversionListVBAResponse' application/json: schema: $ref: '#/components/schemas/UnitConversionListVBAResponse' text/json: schema: $ref: '#/components/schemas/UnitConversionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/unit-type-conversions/{fromUnit}/{toUnit}': get: tags: - Unit Type Conversions summary: Get UnitConversion description: Gets UnitConversion operationId: GetUnitConversion parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fromUnit in: path description: From Unit required: true schema: type: string - name: toUnit in: path description: To Unit required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UnitConversionVBAResponse' application/json: schema: $ref: '#/components/schemas/UnitConversionVBAResponse' text/json: schema: $ref: '#/components/schemas/UnitConversionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Unit Type Conversions summary: Update UnitConversion description: Updates a specific UnitConversion. operationId: UpdateUnitConversion parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fromUnit in: path description: From Unit required: true schema: type: string - name: toUnit in: path description: To Unit required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UnitConversion' text/json: schema: $ref: '#/components/schemas/UnitConversion' application/*+json: schema: $ref: '#/components/schemas/UnitConversion' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UnitConversionVBAResponse' application/json: schema: $ref: '#/components/schemas/UnitConversionVBAResponse' text/json: schema: $ref: '#/components/schemas/UnitConversionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Unit Type Conversions summary: Delete UnitConversion description: Deletes an UnitConversion operationId: DeleteUnitConversion parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: fromUnit in: path description: From Unit required: true schema: type: string - name: toUnit in: path description: To Unit required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /unit-type-conversions-batch: put: tags: - Unit Type Conversions summary: Create or Update Batch UnitConversion description: 'Create or Update multiple UnitConversion at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchUnitConversion parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/UnitConversion' text/json: schema: type: array items: $ref: '#/components/schemas/UnitConversion' application/*+json: schema: type: array items: $ref: '#/components/schemas/UnitConversion' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /unit-types: post: tags: - Unit Types summary: Create UnitType description: Creates a new UnitType operationId: CreateUnitType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UnitType' text/json: schema: $ref: '#/components/schemas/UnitType' application/*+json: schema: $ref: '#/components/schemas/UnitType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UnitTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/UnitTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/UnitTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Unit Types summary: List UnitType description: Lists all UnitType operationId: ListUnitType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UnitTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/UnitTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/UnitTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/unit-types/{unitType}': get: tags: - Unit Types summary: Get UnitType description: Gets UnitType operationId: GetUnitType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: unitType in: path description: Unit Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UnitTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/UnitTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/UnitTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Unit Types summary: Update UnitType description: Updates a specific UnitType. operationId: UpdateUnitType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: unitType in: path description: Unit Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UnitType' text/json: schema: $ref: '#/components/schemas/UnitType' application/*+json: schema: $ref: '#/components/schemas/UnitType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UnitTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/UnitTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/UnitTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Unit Types summary: Delete UnitType description: Deletes an UnitType operationId: DeleteUnitType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: unitType in: path description: Unit Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /unit-types-batch: put: tags: - Unit Types summary: Create or Update Batch UnitType description: 'Create or Update multiple UnitType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchUnitType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/UnitType' text/json: schema: type: array items: $ref: '#/components/schemas/UnitType' application/*+json: schema: type: array items: $ref: '#/components/schemas/UnitType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/amounts': post: tags: - User Amount summary: Create UserAmount description: Creates a new UserAmount operationId: CreateUserAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAmount' text/json: schema: $ref: '#/components/schemas/UserAmount' application/*+json: schema: $ref: '#/components/schemas/UserAmount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserAmountVBAResponse' application/json: schema: $ref: '#/components/schemas/UserAmountVBAResponse' text/json: schema: $ref: '#/components/schemas/UserAmountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - User Amount summary: List UserAmount description: Lists all UserAmount given a specific userID operationId: ListUserAmounts parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserAmountListVBAResponse' application/json: schema: $ref: '#/components/schemas/UserAmountListVBAResponse' text/json: schema: $ref: '#/components/schemas/UserAmountListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/amounts/{userAmountKey}': get: tags: - User Amount summary: Get UserAmount description: Gets UserAmount operationId: GetUserAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: userAmountKey in: path description: UserAmount Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserAmountVBAResponse' application/json: schema: $ref: '#/components/schemas/UserAmountVBAResponse' text/json: schema: $ref: '#/components/schemas/UserAmountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - User Amount summary: Update UserAmount description: Updates a specific UserAmount. operationId: UpdateUserAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: userAmountKey in: path description: UserAmount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAmount' text/json: schema: $ref: '#/components/schemas/UserAmount' application/*+json: schema: $ref: '#/components/schemas/UserAmount' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserAmountVBAResponse' application/json: schema: $ref: '#/components/schemas/UserAmountVBAResponse' text/json: schema: $ref: '#/components/schemas/UserAmountVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - User Amount summary: Delete UserAmount description: Deletes an UserAmount operationId: DeleteUserAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: userAmountKey in: path description: UserAmount Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/amounts-batch': put: tags: - UserAmount summary: Create or Update Batch UserAmount description: 'Create or Update multiple UserAmount at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchUserAmount parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/UserAmount' text/json: schema: type: array items: $ref: '#/components/schemas/UserAmount' application/*+json: schema: type: array items: $ref: '#/components/schemas/UserAmount' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/amounts/{userAmountKey}/procedures': post: tags: - User Amount Procedure summary: Create UserAmountProcedure description: Creates a new UserAmountProcedure operationId: CreateUserAmountProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: userAmountKey in: path description: UserAmount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAmountProcedure' text/json: schema: $ref: '#/components/schemas/UserAmountProcedure' application/*+json: schema: $ref: '#/components/schemas/UserAmountProcedure' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserAmountProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/UserAmountProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/UserAmountProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - User Amount Procedure summary: List UserAmountProcedure description: 'Lists all UserAmountProcedure given a specific userAmountKey,userAmountProcedureKey' operationId: ListUserAmountProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: userAmountKey in: path description: UserAmount Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserAmountProcedureListVBAResponse' application/json: schema: $ref: '#/components/schemas/UserAmountProcedureListVBAResponse' text/json: schema: $ref: '#/components/schemas/UserAmountProcedureListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/amounts/{userAmountKey}/procedures/{userAmountProcedureKey}': get: tags: - User Amount Procedure summary: Get UserAmountProcedure description: Gets UserAmountProcedure operationId: GetUserAmountProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: userAmountKey in: path description: UserAmount Key required: true schema: type: integer format: int32 - name: userAmountProcedureKey in: path description: UserAmountProcedure Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserAmountProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/UserAmountProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/UserAmountProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - User Amount Procedure summary: Update UserAmountProcedure description: Updates a specific UserAmountProcedure. operationId: UpdateUserAmountProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: userAmountKey in: path description: UserAmount Key required: true schema: type: integer format: int32 - name: userAmountProcedureKey in: path description: UserAmountProcedure Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAmountProcedure' text/json: schema: $ref: '#/components/schemas/UserAmountProcedure' application/*+json: schema: $ref: '#/components/schemas/UserAmountProcedure' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserAmountProcedureVBAResponse' application/json: schema: $ref: '#/components/schemas/UserAmountProcedureVBAResponse' text/json: schema: $ref: '#/components/schemas/UserAmountProcedureVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - User Amount Procedure summary: Delete UserAmountProcedure description: Deletes an UserAmountProcedure operationId: DeleteUserAmountProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: userAmountKey in: path description: UserAmount Key required: true schema: type: integer format: int32 - name: userAmountProcedureKey in: path description: UserAmountProcedure Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/amounts/{userAmountKey}/procedures-batch': put: tags: - User Amount Procedure summary: Create or Update Batch UserAmountProcedure description: 'Create or Update multiple UserAmountProcedure at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchUserAmountProcedure parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: userAmountKey in: path description: UserAmount Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/UserAmountProcedure' text/json: schema: type: array items: $ref: '#/components/schemas/UserAmountProcedure' application/*+json: schema: type: array items: $ref: '#/components/schemas/UserAmountProcedure' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/most-visited': get: tags: - User Experience summary: Get the Most Visited Areas description: Get the most visited areas by a specific user. Query parameter Count determines the number of most visited items to find. Days query parameter determines how many days to consider in the search. operationId: GetMostVisited parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: count in: query description: Count schema: type: integer format: int32 default: 3 - name: sinceDays in: query description: Days schema: type: integer format: int32 default: 7 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/MostVisitedListVBAResponse' application/json: schema: $ref: '#/components/schemas/MostVisitedListVBAResponse' text/json: schema: $ref: '#/components/schemas/MostVisitedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/recently-visited': get: tags: - User Experience summary: Get the Recently Visited Areas description: Get recently visited areas by a specific user. Query parameter Count determines the number of recently visited areas to find. Days query parameter determines how many days to consider in the search. operationId: GetRecentlyVisited parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: count in: query description: Count schema: type: integer format: int32 default: 3 - name: sinceDays in: query description: Days schema: type: integer format: int32 default: 7 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/RecentlyVisitedListVBAResponse' application/json: schema: $ref: '#/components/schemas/RecentlyVisitedListVBAResponse' text/json: schema: $ref: '#/components/schemas/RecentlyVisitedListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /user-field-security: get: tags: - User Field Security summary: List USERFIELDSECURITY description: Lists all USERFIELDSECURITY operationId: ListUSERFIELDSECURITY parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userId in: query description: Filter by user id schema: type: string default: '' - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/USERFIELDSECURITYListVBAResponse' application/json: schema: $ref: '#/components/schemas/USERFIELDSECURITYListVBAResponse' text/json: schema: $ref: '#/components/schemas/USERFIELDSECURITYListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /user-groups: post: tags: - User Groups summary: Create UserGroup description: Creates a new UserGroup operationId: CreateUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserGroup' text/json: schema: $ref: '#/components/schemas/UserGroup' application/*+json: schema: $ref: '#/components/schemas/UserGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/UserGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/UserGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - User Groups summary: List UserGroup description: 'Lists all UserGroup ' operationId: ListUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserGroupListVBAResponse' application/json: schema: $ref: '#/components/schemas/UserGroupListVBAResponse' text/json: schema: $ref: '#/components/schemas/UserGroupListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/user-groups/{userGroupKey}': get: tags: - User Groups summary: Get UserGroup description: Gets UserGroup operationId: GetUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/UserGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/UserGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - User Groups summary: Update UserGroup description: Updates a specific UserGroup. operationId: UpdateUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/UserGroup' text/json: schema: $ref: '#/components/schemas/UserGroup' application/*+json: schema: $ref: '#/components/schemas/UserGroup' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserGroupVBAResponse' application/json: schema: $ref: '#/components/schemas/UserGroupVBAResponse' text/json: schema: $ref: '#/components/schemas/UserGroupVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - User Groups summary: Delete UserGroup description: Deletes an UserGroup operationId: DeleteUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /user-groups-batch: put: tags: - User Groups summary: Create or Update Batch UserGroup description: 'Create or Update multiple UserGroup at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchUserGroup parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/UserGroup' text/json: schema: type: array items: $ref: '#/components/schemas/UserGroup' application/*+json: schema: type: array items: $ref: '#/components/schemas/UserGroup' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/user-groups/{userGroupKey}/users/{userID}': post: tags: - User Group Mappings summary: Create UserGroupMapping description: Creates a new UserGroupMapping operationId: CreateUserGroupMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserGroupMappingVBAResponse' application/json: schema: $ref: '#/components/schemas/UserGroupMappingVBAResponse' text/json: schema: $ref: '#/components/schemas/UserGroupMappingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - User Group Mappings summary: Get UserGroupMapping description: Gets UserGroupMapping operationId: GetUserGroupMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserGroupMappingVBAResponse' application/json: schema: $ref: '#/components/schemas/UserGroupMappingVBAResponse' text/json: schema: $ref: '#/components/schemas/UserGroupMappingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - User Group Mappings summary: Delete UserGroupMapping description: Deletes an UserGroupMapping operationId: DeleteUserGroupMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/user-groups/{userGroupKey}/users': get: tags: - User Group Mappings summary: List UserGroupMapping description: Lists all UserGroupMapping for a specific userGroupKey operationId: ListUserGroupMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserGroupMappingListVBAResponse' application/json: schema: $ref: '#/components/schemas/UserGroupMappingListVBAResponse' text/json: schema: $ref: '#/components/schemas/UserGroupMappingListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /user-group-mappings: get: tags: - User Group Mappings summary: List UserGroupMapping description: Lists all UserGroupMappings with optional filter for User_ID operationId: ListUserGroupMappingFiltered parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: User_ID in: query description: User_ID schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserGroupMappingListVBAResponse' application/json: schema: $ref: '#/components/schemas/UserGroupMappingListVBAResponse' text/json: schema: $ref: '#/components/schemas/UserGroupMappingListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/user-groups/{userGroupKey}/users-batch': put: tags: - User Group Mappings summary: Create multiple UserGroupMappings description: 'Create multiple UserGroupMapping at once. If the entity already exists, an error will be returned for that item. If the entity does not exist, it will be created.' operationId: UpdateBatchUserGroupMapping parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userGroupKey in: path description: UserGroup Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/UserGroupMapping' text/json: schema: type: array items: $ref: '#/components/schemas/UserGroupMapping' application/*+json: schema: type: array items: $ref: '#/components/schemas/UserGroupMapping' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/log-types/{logType}': post: tags: - User LogTypes summary: Create UserLogType Assignment description: Creates a new link between an existing User and a LogType operationId: CreateUserLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: logType in: path description: Log Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserLogTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/UserLogTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/UserLogTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - User LogTypes summary: Get UserLogType description: Gets UserLogType operationId: GetUserLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: logType in: path description: LogType required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserLogTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/UserLogTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/UserLogTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - User LogTypes summary: Delete User LogType description: Deletes a specific User to LogType assignment operationId: DeleteUserLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: logType in: path description: Log Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/log-types': get: tags: - User LogTypes summary: List User LogTypes description: Lists all LogTypes for a specific User ID operationId: ListUserLogTypes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserLogTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/UserLogTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/UserLogTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/log-types-batch': put: tags: - User LogTypes summary: Create Batch User LogType description: Create multiple User LogType assignments at once. operationId: UpdateBatchUserLogType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/UserLogType' text/json: schema: type: array items: $ref: '#/components/schemas/UserLogType' application/*+json: schema: type: array items: $ref: '#/components/schemas/UserLogType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/note-access': post: tags: - User Note Access summary: Create User Note Access description: Creates a new User Note Access operationId: CreateUserNoteAccess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserNoteAccess' text/json: schema: $ref: '#/components/schemas/UserNoteAccess' application/*+json: schema: $ref: '#/components/schemas/UserNoteAccess' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserNoteAccessVBAResponse' application/json: schema: $ref: '#/components/schemas/UserNoteAccessVBAResponse' text/json: schema: $ref: '#/components/schemas/UserNoteAccessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - User Note Access summary: List User Note Access description: Lists all User Note Access given a specific userID operationId: ListUserNoteAccess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserNoteAccessListVBAResponse' application/json: schema: $ref: '#/components/schemas/UserNoteAccessListVBAResponse' text/json: schema: $ref: '#/components/schemas/UserNoteAccessListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/note-access/{userNoteAccessKey}': get: tags: - User Note Access summary: Get User Note Access description: Gets User Note Access operationId: GetUserNoteAccess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: userNoteAccessKey in: path description: UserNoteAccess Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserNoteAccessVBAResponse' application/json: schema: $ref: '#/components/schemas/UserNoteAccessVBAResponse' text/json: schema: $ref: '#/components/schemas/UserNoteAccessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - User Note Access summary: Update User Note Access description: Updates a specific User Note Access. operationId: UpdateUserNoteAccess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: userNoteAccessKey in: path description: UserNoteAccess Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/UserNoteAccess' text/json: schema: $ref: '#/components/schemas/UserNoteAccess' application/*+json: schema: $ref: '#/components/schemas/UserNoteAccess' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserNoteAccessVBAResponse' application/json: schema: $ref: '#/components/schemas/UserNoteAccessVBAResponse' text/json: schema: $ref: '#/components/schemas/UserNoteAccessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - User Note Access summary: Delete User Note Access description: Deletes an User Note Access operationId: DeleteUserNoteAccess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: userNoteAccessKey in: path description: User Note Access Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/note-access-batch': put: tags: - User Note Access summary: Create or Update Batch User Note Access description: 'Create or Update multiple User Note Access at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchUserNoteAccess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/UserNoteAccess' text/json: schema: type: array items: $ref: '#/components/schemas/UserNoteAccess' application/*+json: schema: type: array items: $ref: '#/components/schemas/UserNoteAccess' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /users: post: tags: - User summary: Create User description: Creates a new User operationId: CreateUsers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Users' text/json: schema: $ref: '#/components/schemas/Users' application/*+json: schema: $ref: '#/components/schemas/Users' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UsersVBAResponse' application/json: schema: $ref: '#/components/schemas/UsersVBAResponse' text/json: schema: $ref: '#/components/schemas/UsersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - User summary: List Users description: Lists all Users operationId: ListUsers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UsersListVBAResponse' application/json: schema: $ref: '#/components/schemas/UsersListVBAResponse' text/json: schema: $ref: '#/components/schemas/UsersListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}': get: tags: - User summary: Get User description: Gets a User by ID operationId: GetUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UsersVBAResponse' application/json: schema: $ref: '#/components/schemas/UsersVBAResponse' text/json: schema: $ref: '#/components/schemas/UsersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - User summary: Update User description: Updates a specific User operationId: UpdateUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Users' text/json: schema: $ref: '#/components/schemas/Users' application/*+json: schema: $ref: '#/components/schemas/Users' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UsersVBAResponse' application/json: schema: $ref: '#/components/schemas/UsersVBAResponse' text/json: schema: $ref: '#/components/schemas/UsersVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - User summary: Delete User description: Delete a User operationId: DeleteUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /users-batch: put: tags: - User summary: Create or Update Batch Users description: 'Create or Update multiple Users at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchUsers parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Users' text/json: schema: type: array items: $ref: '#/components/schemas/Users' application/*+json: schema: type: array items: $ref: '#/components/schemas/Users' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /client-environments: get: tags: - Client Config summary: List Client Environments description: Lists the client environments that are available for the given client id and client code. operationId: ListClientEnvironments parameters: - name: vbasoftware-client-id in: header description: Client ID required: true schema: type: string - name: vbasoftware-client-code in: header description: Client Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_ClientEnvironmentListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_ClientEnvironmentListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_ClientEnvironmentListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] '/app-info/{environment}': get: tags: - Client Config summary: Get Application Information description: 'Returns the latest application information including version, file details, release notes, and release date in JSON format.' operationId: GetAppInfo parameters: - name: vbasoftware-client-id in: header description: Client ID required: true schema: type: string - name: vbasoftware-client-code in: header description: Client Code required: true schema: type: string - name: environment in: path description: environment required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_AppInfoVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_AppInfoVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_AppInfoVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] '/groups/{groupID}/disenroll-affected-claims': get: tags: - Group Disenroll Affected Claims summary: Get Affected Claims for Disrolling Group ID description: List Affected Claims for Disrolling Group ID operationId: ListGroupDisenrollAffectedClaims parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: groupID in: path description: Group ID required: true schema: type: string - name: disenrollDate in: query description: Disenroll Date required: true schema: type: string format: date-time - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_GroupDisenrollAffectedClaimsListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_GroupDisenrollAffectedClaimsListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_GroupDisenrollAffectedClaimsListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /payor-accounts/check-processing: get: tags: - Payor Accounts summary: List Payor Accounts for Check Processing description: Gets a list of Payor Accounts for Check Processing operationId: ListPayorAccountCheckProcessing parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_PayorAccountCheckProcessingVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_PayorAccountCheckProcessingVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_PayorAccountCheckProcessingVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /reports: get: tags: - VBA Reports summary: List VBA Report description: Lists all VBA Report operationId: ListVBA_Reports parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBA_ReportListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBA_ReportListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBA_ReportListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /sso-callback: get: tags: - Client Config summary: SSO Callback description: 'This endpoint is the callback URL for the Single Sign-On (SSO) process. It receives an authorization code from the identity provider (e.g., Cognito) and exchanges it for an access token. The access token is then used to authenticate the user in the application.' operationId: ssoCallback parameters: - name: state in: query description: base64 encoded state required: true schema: type: string - name: code in: query description: Authorization Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserAuthenticationResponseVBAResponse' application/json: schema: $ref: '#/components/schemas/UserAuthenticationResponseVBAResponse' text/json: schema: $ref: '#/components/schemas/UserAuthenticationResponseVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] '/users/{userID}/vbagateway-subscriptions': post: tags: - VBAGateway Subscription summary: Create VBAGatewaySubscription description: Creates a new VBAGatewaySubscription operationId: CreateVBAGatewaySubscription parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAGatewaySubscription' text/json: schema: $ref: '#/components/schemas/VBAGatewaySubscription' application/*+json: schema: $ref: '#/components/schemas/VBAGatewaySubscription' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - VBAGateway Subscription summary: List VBAGatewaySubscription description: Lists all VBAGatewaySubscription given a specific userID operationId: ListVBAGatewaySubscription parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/vbagateway-subscriptions/{vBAGatewaySubscriptionKey}': get: tags: - VBAGateway Subscription summary: Get VBAGatewaySubscription description: Gets VBAGatewaySubscription operationId: GetVBAGatewaySubscription parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: vBAGatewaySubscriptionKey in: path description: VBAGatewaySubscription Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - VBAGateway Subscription summary: Update VBAGatewaySubscription description: Updates a specific VBAGatewaySubscription. operationId: UpdateVBAGatewaySubscription parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: vBAGatewaySubscriptionKey in: path description: VBAGatewaySubscription Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAGatewaySubscription' text/json: schema: $ref: '#/components/schemas/VBAGatewaySubscription' application/*+json: schema: $ref: '#/components/schemas/VBAGatewaySubscription' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - VBAGateway Subscription summary: Delete VBAGatewaySubscription description: Deletes an VBAGatewaySubscription operationId: DeleteVBAGatewaySubscription parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: vBAGatewaySubscriptionKey in: path description: VBAGatewaySubscription Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/vbagateway-subscriptions-batch': put: tags: - VBAGateway Subscription summary: Create or Update Batch VBAGatewaySubscription description: 'Create or Update multiple VBAGatewaySubscription at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchVBAGatewaySubscription parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VBAGatewaySubscription' text/json: schema: type: array items: $ref: '#/components/schemas/VBAGatewaySubscription' application/*+json: schema: type: array items: $ref: '#/components/schemas/VBAGatewaySubscription' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/vbagateway-subscriptions/{vBAGatewaySubscriptionKey}/details': post: tags: - VBAGateway Subscription Detail summary: Create VBAGatewaySubscriptionDetail description: Creates a new VBAGatewaySubscriptionDetail operationId: CreateVBAGatewaySubscriptionDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: vBAGatewaySubscriptionKey in: path description: VBAGatewaySubscription Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetail' text/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetail' application/*+json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - VBAGateway Subscription Detail summary: List VBAGatewaySubscriptionDetail description: Lists all VBAGatewaySubscriptionDetail given a specific vBAGatewaySubscriptionKey operationId: ListVBAGatewaySubscriptionDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: vBAGatewaySubscriptionKey in: path description: VBAGatewaySubscription Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/vbagateway-subscriptions/{vBAGatewaySubscriptionKey}/details/{vBAGatewaySubscriptionDetailKey}': get: tags: - VBAGateway Subscription Detail summary: Get VBAGatewaySubscriptionDetail description: Gets VBAGatewaySubscriptionDetail operationId: GetVBAGatewaySubscriptionDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: vBAGatewaySubscriptionKey in: path description: VBAGatewaySubscription Key required: true schema: type: integer format: int32 - name: vBAGatewaySubscriptionDetailKey in: path description: VBAGatewaySubscriptionDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - VBAGateway Subscription Detail summary: Update VBAGatewaySubscriptionDetail description: Updates a specific VBAGatewaySubscriptionDetail. operationId: UpdateVBAGatewaySubscriptionDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: vBAGatewaySubscriptionKey in: path description: VBAGatewaySubscription Key required: true schema: type: integer format: int32 - name: vBAGatewaySubscriptionDetailKey in: path description: VBAGatewaySubscriptionDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetail' text/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetail' application/*+json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAGatewaySubscriptionDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - VBAGateway Subscription Detail summary: Delete VBAGatewaySubscriptionDetail description: Deletes an VBAGatewaySubscriptionDetail operationId: DeleteVBAGatewaySubscriptionDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: vBAGatewaySubscriptionKey in: path description: VBAGatewaySubscription Key required: true schema: type: integer format: int32 - name: vBAGatewaySubscriptionDetailKey in: path description: VBAGatewaySubscriptionDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/users/{userID}/vbagateway-subscriptions/{vBAGatewaySubscriptionKey}/details-batch': put: tags: - VBAGateway Subscription Detail summary: Create or Update Batch VBAGatewaySubscriptionDetail description: 'Create or Update multiple VBAGatewaySubscriptionDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchVBAGatewaySubscriptionDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: userID in: path description: User ID required: true schema: type: string - name: vBAGatewaySubscriptionKey in: path description: VBAGatewaySubscription Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VBAGatewaySubscriptionDetail' text/json: schema: type: array items: $ref: '#/components/schemas/VBAGatewaySubscriptionDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/VBAGatewaySubscriptionDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /vba-interfaces: post: tags: - VBAInterfaces summary: Create VBAInterface description: Creates a new VBAInterface operationId: CreateVBAInterface parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAInterface' text/json: schema: $ref: '#/components/schemas/VBAInterface' application/*+json: schema: $ref: '#/components/schemas/VBAInterface' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - VBAInterfaces summary: List VBAInterface description: Lists all VBAInterface operationId: ListVBAInterface parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vba-interfaces/{vBAInterfaceKey}': get: tags: - VBAInterfaces summary: Get VBAInterface description: Gets VBAInterface operationId: GetVBAInterface parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - VBAInterfaces summary: Update VBAInterface description: Updates a specific VBAInterface. operationId: UpdateVBAInterface parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAInterface' text/json: schema: $ref: '#/components/schemas/VBAInterface' application/*+json: schema: $ref: '#/components/schemas/VBAInterface' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - VBAInterfaces summary: Delete VBAInterface description: Deletes an VBAInterface operationId: DeleteVBAInterface parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /vba-interfaces-batch: put: tags: - VBAInterfaces summary: Create or Update Batch VBAInterface description: 'Create or Update multiple VBAInterface at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchVBAInterface parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VBAInterface' text/json: schema: type: array items: $ref: '#/components/schemas/VBAInterface' application/*+json: schema: type: array items: $ref: '#/components/schemas/VBAInterface' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vba-interfaces/{vBAInterfaceKey}/id-codes': post: tags: - VBAInterface ID Codes summary: Create VBAInterfaceIDCode description: Creates a new VBAInterfaceIDCode operationId: CreateVBAInterfaceIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAInterfaceIDCode' text/json: schema: $ref: '#/components/schemas/VBAInterfaceIDCode' application/*+json: schema: $ref: '#/components/schemas/VBAInterfaceIDCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceIDCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceIDCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceIDCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - VBAInterface ID Codes summary: List VBAInterfaceIDCode description: Lists all VBAInterfaceIDCode for the given vBAInterfaceKey operationId: ListVBAInterfaceIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceIDCodeListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceIDCodeListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceIDCodeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vba-interfaces/{vBAInterfaceKey}/id-codes/{type}/{iDCode}': get: tags: - VBAInterface ID Codes summary: Get VBAInterfaceIDCode description: Gets VBAInterfaceIDCode operationId: GetVBAInterfaceIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 - name: type in: path description: Type required: true schema: type: string - name: iDCode in: path description: ID Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceIDCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceIDCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceIDCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - VBAInterface ID Codes summary: Update VBAInterfaceIDCode description: Updates a specific VBAInterfaceIDCode. operationId: UpdateVBAInterfaceIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 - name: type in: path description: Type required: true schema: type: string - name: iDCode in: path description: ID Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAInterfaceIDCode' text/json: schema: $ref: '#/components/schemas/VBAInterfaceIDCode' application/*+json: schema: $ref: '#/components/schemas/VBAInterfaceIDCode' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceIDCodeVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceIDCodeVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceIDCodeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - VBAInterface ID Codes summary: Delete VBAInterfaceIDCode description: Deletes an VBAInterfaceIDCode operationId: DeleteVBAInterfaceIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 - name: type in: path description: Type required: true schema: type: string - name: iDCode in: path description: ID Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vba-interfaces/{vBAInterfaceKey}/id-codes-batch': put: tags: - VBAInterface ID Codes summary: Create or Update Batch VBAInterfaceIDCode description: 'Create or Update multiple VBAInterfaceIDCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchVBAInterfaceIDCode parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceIDCode' text/json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceIDCode' application/*+json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceIDCode' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vba-interfaces/{vBAInterfaceKey}/map-types': post: tags: - VBAInterface Map Types summary: Create VBAInterfaceMapType description: Creates a new VBAInterfaceMapType operationId: CreateVBAInterfaceMapType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAInterfaceMapType' text/json: schema: $ref: '#/components/schemas/VBAInterfaceMapType' application/*+json: schema: $ref: '#/components/schemas/VBAInterfaceMapType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceMapTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceMapTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceMapTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - VBAInterface Map Types summary: List VBAInterfaceMapType description: Lists all VBAInterfaceMapType for the given vBAInterfaceKey operationId: ListVBAInterfaceMapType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceMapTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceMapTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceMapTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vba-interfaces/{vBAInterfaceKey}/map-types/{mapType}': get: tags: - VBAInterface Map Types summary: Get VBAInterfaceMapType description: Gets VBAInterfaceMapType operationId: GetVBAInterfaceMapType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 - name: mapType in: path description: Map Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceMapTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceMapTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceMapTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - VBAInterface Map Types summary: Update VBAInterfaceMapType description: Updates a specific VBAInterfaceMapType. operationId: UpdateVBAInterfaceMapType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 - name: mapType in: path description: Map Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAInterfaceMapType' text/json: schema: $ref: '#/components/schemas/VBAInterfaceMapType' application/*+json: schema: $ref: '#/components/schemas/VBAInterfaceMapType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceMapTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceMapTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceMapTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - VBAInterface Map Types summary: Delete VBAInterfaceMapType description: Deletes an VBAInterfaceMapType operationId: DeleteVBAInterfaceMapType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 - name: mapType in: path description: Map Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vba-interfaces/{vBAInterfaceKey}/map-types-batch': put: tags: - VBAInterface Map Types summary: Create or Update Batch VBAInterfaceMapType description: 'Create or Update multiple VBAInterfaceMapType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchVBAInterfaceMapType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceKey in: path description: VBAInterface Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceMapType' text/json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceMapType' application/*+json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceMapType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /vba-interface-statuses: post: tags: - VBAInterface Statuses summary: Create VBAInterfaceStatus description: Creates a new VBAInterfaceStatus operationId: CreateVBAInterfaceStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAInterfaceStatus' text/json: schema: $ref: '#/components/schemas/VBAInterfaceStatus' application/*+json: schema: $ref: '#/components/schemas/VBAInterfaceStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - VBAInterface Statuses summary: List VBAInterfaceStatus description: Lists all VBAInterfaceStatus operationId: ListVBAInterfaceStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceStatusListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceStatusListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceStatusListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vba-interface-statuses/{vBAInterfaceStatus}': get: tags: - VBAInterface Statuses summary: Get VBAInterfaceStatus description: Gets VBAInterfaceStatus operationId: GetVBAInterfaceStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceStatus in: path description: VBAInterface Status required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - VBAInterface Statuses summary: Update VBAInterfaceStatus description: Updates a specific VBAInterfaceStatus. operationId: UpdateVBAInterfaceStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceStatus in: path description: VBAInterface Status required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAInterfaceStatus' text/json: schema: $ref: '#/components/schemas/VBAInterfaceStatus' application/*+json: schema: $ref: '#/components/schemas/VBAInterfaceStatus' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceStatusVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceStatusVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceStatusVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - VBAInterface Statuses summary: Delete VBAInterfaceStatus description: Deletes an VBAInterfaceStatus operationId: DeleteVBAInterfaceStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceStatus in: path description: VBAInterface Status required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /vba-interface-statuses-batch: put: tags: - VBAInterface Statuses summary: Create or Update Batch VBAInterfaceStatus description: 'Create or Update multiple VBAInterfaceStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchVBAInterfaceStatus parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceStatus' text/json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceStatus' application/*+json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceStatus' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /vba-interface-types: post: tags: - VBAInterface Types summary: Create VBAInterfaceType description: Creates a new VBAInterfaceType operationId: CreateVBAInterfaceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAInterfaceType' text/json: schema: $ref: '#/components/schemas/VBAInterfaceType' application/*+json: schema: $ref: '#/components/schemas/VBAInterfaceType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - VBAInterface Types summary: List VBAInterfaceType description: Lists all VBAInterfaceType operationId: ListVBAInterfaceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vba-interface-types/{vBAInterfaceType}': get: tags: - VBAInterface Types summary: Get VBAInterfaceType description: Gets VBAInterfaceType operationId: GetVBAInterfaceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceType in: path description: VBAInterface Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - VBAInterface Types summary: Update VBAInterfaceType description: Updates a specific VBAInterfaceType. operationId: UpdateVBAInterfaceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceType in: path description: VBAInterface Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAInterfaceType' text/json: schema: $ref: '#/components/schemas/VBAInterfaceType' application/*+json: schema: $ref: '#/components/schemas/VBAInterfaceType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - VBAInterface Types summary: Delete VBAInterfaceType description: Deletes an VBAInterfaceType operationId: DeleteVBAInterfaceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceType in: path description: VBAInterface Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /vba-interface-types-batch: put: tags: - VBAInterface Types summary: Create or Update Batch VBAInterfaceType description: 'Create or Update multiple VBAInterfaceType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchVBAInterfaceType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceType' text/json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceType' application/*+json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /vba-interface-vendors: post: tags: - VBAInterface Vendors summary: Create VBAInterfaceVendor description: Creates a new VBAInterfaceVendor operationId: CreateVBAInterfaceVendor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAInterfaceVendor' text/json: schema: $ref: '#/components/schemas/VBAInterfaceVendor' application/*+json: schema: $ref: '#/components/schemas/VBAInterfaceVendor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceVendorVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceVendorVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceVendorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - VBAInterface Vendors summary: List VBAInterfaceVendor description: Lists all VBAInterfaceVendor operationId: ListVBAInterfaceVendor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceVendorListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceVendorListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceVendorListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vba-interface-vendors/{vBAInterfaceVendor}': get: tags: - VBAInterface Vendors summary: Get VBAInterfaceVendor description: Gets VBAInterfaceVendor operationId: GetVBAInterfaceVendor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceVendor in: path description: VBAInterface Vendor required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceVendorVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceVendorVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceVendorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - VBAInterface Vendors summary: Update VBAInterfaceVendor description: Updates a specific VBAInterfaceVendor. operationId: UpdateVBAInterfaceVendor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceVendor in: path description: VBAInterface Vendor required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAInterfaceVendor' text/json: schema: $ref: '#/components/schemas/VBAInterfaceVendor' application/*+json: schema: $ref: '#/components/schemas/VBAInterfaceVendor' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAInterfaceVendorVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAInterfaceVendorVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAInterfaceVendorVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - VBAInterface Vendors summary: Delete VBAInterfaceVendor description: Deletes an VBAInterfaceVendor operationId: DeleteVBAInterfaceVendor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAInterfaceVendor in: path description: VBAInterface Vendor required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /vba-interface-vendors-batch: put: tags: - VBAInterface Vendors summary: Create or Update Batch VBAInterfaceVendor description: 'Create or Update multiple VBAInterfaceVendor at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchVBAInterfaceVendor parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceVendor' text/json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceVendor' application/*+json: schema: type: array items: $ref: '#/components/schemas/VBAInterfaceVendor' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /vbaprocesses: post: tags: - Processes summary: Create VBAProcess description: Creates a new VBAProcess operationId: CreateVBAProcess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAProcess' text/json: schema: $ref: '#/components/schemas/VBAProcess' application/*+json: schema: $ref: '#/components/schemas/VBAProcess' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}': get: tags: - Processes summary: Get VBAProcess description: Gets VBAProcess operationId: GetVBAProcess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Processes summary: Update VBAProcess description: Updates a specific VBAProcess. operationId: UpdateVBAProcess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAProcess' text/json: schema: $ref: '#/components/schemas/VBAProcess' application/*+json: schema: $ref: '#/components/schemas/VBAProcess' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Processes summary: Delete VBAProcess description: Deletes an VBAProcess operationId: DeleteVBAProcess parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/logs': post: tags: - Process Logging summary: Create VBAProcessLog description: Creates a new VBAProcessLog operationId: CreateVBAProcessLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAProcessLog' text/json: schema: $ref: '#/components/schemas/VBAProcessLog' application/*+json: schema: $ref: '#/components/schemas/VBAProcessLog' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessLogVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessLogVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Process Logging summary: List VBAProcessLog description: List VBAProcessLogs or the given VBAProcessKey and VBAProcessType operationId: ListVBAProcessLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessLogListVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessLogListVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessLogListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/logs/{vBAProcessLogKey}': get: tags: - Process Logging summary: Get VBAProcessLog description: Gets VBAProcessLog operationId: GetVBAProcessLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string - name: vBAProcessLogKey in: path description: VBAProcessLog Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessLogVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessLogVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Process Logging summary: Update VBAProcessLog description: Updates a specific VBAProcessLog. operationId: UpdateVBAProcessLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string - name: vBAProcessLogKey in: path description: VBAProcessLog Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAProcessLog' text/json: schema: $ref: '#/components/schemas/VBAProcessLog' application/*+json: schema: $ref: '#/components/schemas/VBAProcessLog' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessLogVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessLogVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessLogVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Process Logging summary: Delete VBAProcessLog description: Deletes an VBAProcessLog operationId: DeleteVBAProcessLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string - name: vBAProcessLogKey in: path description: VBAProcessLog Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/logs-batch': put: tags: - Process Logging summary: Update Batch VBAProcessLog description: Updates or Creates multiple VBAProcessLogs operationId: UpdateBatchVBAProcessLog parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VBAProcessLog' text/json: schema: type: array items: $ref: '#/components/schemas/VBAProcessLog' application/*+json: schema: type: array items: $ref: '#/components/schemas/VBAProcessLog' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/parameters': post: tags: - Process Parameters summary: Create VBAProcessParameter description: Creates a new VBAProcessParameter operationId: CreateVBAProcessParameter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAProcessParameter' text/json: schema: $ref: '#/components/schemas/VBAProcessParameter' application/*+json: schema: $ref: '#/components/schemas/VBAProcessParameter' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessParameterVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessParameterVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessParameterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/parameters/{vBAProcessParameterKey}': get: tags: - Process Parameters summary: Get VBAProcessParameter description: Gets VBAProcessParameter operationId: GetVBAProcessParameter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string - name: vBAProcessParameterKey in: path description: VBAProcessParameter Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessParameterVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessParameterVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessParameterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Process Parameters summary: Update VBAProcessParameter description: Updates a specific VBAProcessParameter. operationId: UpdateVBAProcessParameter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string - name: vBAProcessParameterKey in: path description: VBAProcessParameter Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/VBAProcessParameter' text/json: schema: $ref: '#/components/schemas/VBAProcessParameter' application/*+json: schema: $ref: '#/components/schemas/VBAProcessParameter' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/VBAProcessParameterVBAResponse' application/json: schema: $ref: '#/components/schemas/VBAProcessParameterVBAResponse' text/json: schema: $ref: '#/components/schemas/VBAProcessParameterVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Process Parameters summary: Delete VBAProcessParameter description: Deletes an VBAProcessParameter operationId: DeleteVBAProcessParameter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string - name: vBAProcessParameterKey in: path description: VBAProcessParameter Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/parameters-batch': put: tags: - Process Parameters summary: Update Batch VBAProcessParameter description: Updates a multiple VBAProcessParameter. operationId: UpdateBatchVBAProcessParameter parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: vBAProcessKey in: path description: VBAProcess Key required: true schema: type: integer format: int32 - name: vBAProcessType in: path description: VBAProcess Type required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VBAProcessParameter' text/json: schema: type: array items: $ref: '#/components/schemas/VBAProcessParameter' application/*+json: schema: type: array items: $ref: '#/components/schemas/VBAProcessParameter' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /process-automation/report/email: post: tags: - Process Automation summary: Send Report Email description: Sends an email with attached report operationId: SendReportEmail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailReportDTO' text/json: schema: $ref: '#/components/schemas/EmailReportDTO' application/*+json: schema: $ref: '#/components/schemas/EmailReportDTO' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /process-automation/report/fax: post: tags: - Process Automation summary: Send Report Fax description: Sends a report via fax operationId: SendReportFax parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FaxReportDTO' text/json: schema: $ref: '#/components/schemas/FaxReportDTO' application/*+json: schema: $ref: '#/components/schemas/FaxReportDTO' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /process-automation/sms: post: tags: - Process Automation summary: Send or schedule SMS description: Sends or schedules an SMS operationId: SendSMS parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SMSDTO' text/json: schema: $ref: '#/components/schemas/SMSDTO' application/*+json: schema: $ref: '#/components/schemas/SMSDTO' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/StringVBAResponse' application/json: schema: $ref: '#/components/schemas/StringVBAResponse' text/json: schema: $ref: '#/components/schemas/StringVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /workflows: post: tags: - Workflows summary: Create Workflow description: Creates a new Workflow operationId: CreateWorkflow parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Workflow' text/json: schema: $ref: '#/components/schemas/Workflow' application/*+json: schema: $ref: '#/components/schemas/Workflow' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Workflows summary: List Workflow description: Lists all Workflow operationId: ListWorkflow parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowListVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowListVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflows/{workflowKey}': get: tags: - Workflows summary: Get Workflow description: Gets Workflow operationId: GetWorkflow parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Workflows summary: Update Workflow description: Updates a specific Workflow. operationId: UpdateWorkflow parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Workflow' text/json: schema: $ref: '#/components/schemas/Workflow' application/*+json: schema: $ref: '#/components/schemas/Workflow' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Workflows summary: Delete Workflow description: Deletes an Workflow operationId: DeleteWorkflow parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /workflows-batch: put: tags: - Workflows summary: Create or Update Batch Workflow description: 'Create or Update multiple Workflow at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchWorkflow parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Workflow' text/json: schema: type: array items: $ref: '#/components/schemas/Workflow' application/*+json: schema: type: array items: $ref: '#/components/schemas/Workflow' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /workflow-details: post: tags: - Workflow Details summary: Create WorkflowDetail description: Creates a new WorkflowDetail operationId: CreateWorkflowDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowDetail' text/json: schema: $ref: '#/components/schemas/WorkflowDetail' application/*+json: schema: $ref: '#/components/schemas/WorkflowDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Workflow Details summary: List WorkflowDetail description: Lists all WorkflowDetail operationId: ListWorkflowDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowDetailListVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowDetailListVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowDetailListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflow-details/{workflowDetailKey}': get: tags: - Workflow Details summary: Get WorkflowDetail description: Gets WorkflowDetail operationId: GetWorkflowDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowDetailKey in: path description: WorkflowDetail Key required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Workflow Details summary: Update WorkflowDetail description: Updates a specific WorkflowDetail. operationId: UpdateWorkflowDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowDetailKey in: path description: WorkflowDetail Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowDetail' text/json: schema: $ref: '#/components/schemas/WorkflowDetail' application/*+json: schema: $ref: '#/components/schemas/WorkflowDetail' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowDetailVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowDetailVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowDetailVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Workflow Details summary: Delete WorkflowDetail description: Deletes an WorkflowDetail operationId: DeleteWorkflowDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowDetailKey in: path description: WorkflowDetail Key required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /workflow-details-batch: put: tags: - Workflow Details summary: Create or Update Batch WorkflowDetail description: 'Create or Update multiple WorkflowDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchWorkflowDetail parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/WorkflowDetail' text/json: schema: type: array items: $ref: '#/components/schemas/WorkflowDetail' application/*+json: schema: type: array items: $ref: '#/components/schemas/WorkflowDetail' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /workflow-complete: post: tags: - Adv. Workflow summary: Complete Workflow Items description: Set a list of WorkflowDetail records to Complete. operationId: WorkflowProcessingComplete parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowProcessing' text/json: schema: $ref: '#/components/schemas/WorkflowProcessing' application/*+json: schema: $ref: '#/components/schemas/WorkflowProcessing' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /workflow-reject: post: tags: - Adv. Workflow summary: Reject Workflow Items description: Set a list of WorkflowDetail records to Reject. operationId: WorkflowProcessingReject parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowProcessing' text/json: schema: $ref: '#/components/schemas/WorkflowProcessing' application/*+json: schema: $ref: '#/components/schemas/WorkflowProcessing' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /workflow-process-claims: post: tags: - Adv. Workflow summary: Process Workflow Claims description: Set a list of Claims in Batch to Process. operationId: WorkflowProcessingProcessClaims parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowProcessing' text/json: schema: $ref: '#/components/schemas/WorkflowProcessing' application/*+json: schema: $ref: '#/components/schemas/WorkflowProcessing' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true /workflow-assign: post: tags: - Adv. Workflow summary: Assign Workflow Items description: Set a list of WorkflowDetail records to Assign. operationId: WorkflowProcessingAssign parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowProcessing' text/json: schema: $ref: '#/components/schemas/WorkflowProcessing' application/*+json: schema: $ref: '#/components/schemas/WorkflowProcessing' required: true responses: '202': description: Accepted for processing '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] x-advanced: true '/workflows/{workflowKey}/tasks': post: tags: - Workflow Tasks summary: Create WorkflowTask description: Creates a new WorkflowTask operationId: CreateWorkflowTask parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowTask' text/json: schema: $ref: '#/components/schemas/WorkflowTask' application/*+json: schema: $ref: '#/components/schemas/WorkflowTask' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTaskVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTaskVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTaskVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Workflow Tasks summary: List WorkflowTask description: Lists all WorkflowTask for the given workflowKey operationId: ListWorkflowTask parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTaskListVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTaskListVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTaskListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflows/{workflowKey}/tasks/{workflowTaskSeq}': get: tags: - Workflow Tasks summary: Get WorkflowTask description: Gets WorkflowTask operationId: GetWorkflowTask parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTaskVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTaskVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTaskVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Workflow Tasks summary: Update WorkflowTask description: Updates a specific WorkflowTask. operationId: UpdateWorkflowTask parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowTask' text/json: schema: $ref: '#/components/schemas/WorkflowTask' application/*+json: schema: $ref: '#/components/schemas/WorkflowTask' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTaskVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTaskVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTaskVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Workflow Tasks summary: Delete WorkflowTask description: Deletes an WorkflowTask operationId: DeleteWorkflowTask parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflows/{workflowKey}/tasks-batch': put: tags: - Workflow Tasks summary: Create or Update Batch WorkflowTask description: 'Create or Update multiple WorkflowTask at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchWorkflowTask parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/WorkflowTask' text/json: schema: type: array items: $ref: '#/components/schemas/WorkflowTask' application/*+json: schema: type: array items: $ref: '#/components/schemas/WorkflowTask' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflows/{workflowKey}/tasks/{workflowTaskSeq}/options': post: tags: - Workflow Task Options summary: Create WorkflowTaskOption description: Creates a new WorkflowTaskOption operationId: CreateWorkflowTaskOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowTaskOption' text/json: schema: $ref: '#/components/schemas/WorkflowTaskOption' application/*+json: schema: $ref: '#/components/schemas/WorkflowTaskOption' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTaskOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTaskOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTaskOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Workflow Task Options summary: List WorkflowTaskOption description: Lists all WorkflowTaskOption for the given workflowKey and workflowTaskSeq operationId: ListWorkflowTaskOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTaskOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTaskOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTaskOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflows/{workflowKey}/tasks/{workflowTaskSeq}/options/{workflowTaskOption}': get: tags: - Workflow Task Options summary: Get WorkflowTaskOption description: Gets WorkflowTaskOption operationId: GetWorkflowTaskOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 - name: workflowTaskOption in: path description: WorkflowTask Option required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTaskOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTaskOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTaskOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Workflow Task Options summary: Delete WorkflowTaskOption description: Deletes an WorkflowTaskOption operationId: DeleteWorkflowTaskOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 - name: workflowTaskOption in: path description: WorkflowTask Option required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflows/{workflowKey}/tasks/{workflowTaskSeq}/options-batch': put: tags: - Workflow Task Options summary: Create Batch WorkflowTaskOption description: 'Create multiple WorkflowTaskOption at once. If the entity does not exist, it will be created. If the entity does exist, an error message will be treturned.' operationId: UpdateBatchWorkflowTaskOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/WorkflowTaskOption' text/json: schema: type: array items: $ref: '#/components/schemas/WorkflowTaskOption' application/*+json: schema: type: array items: $ref: '#/components/schemas/WorkflowTaskOption' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflows/{workflowKey}/tasks/{workflowTaskSeq}/users': post: tags: - Workflow Task Users summary: Create WorkflowTaskUser description: Creates a new WorkflowTaskUser operationId: CreateWorkflowTaskUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowTaskUser' text/json: schema: $ref: '#/components/schemas/WorkflowTaskUser' application/*+json: schema: $ref: '#/components/schemas/WorkflowTaskUser' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTaskUserVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTaskUserVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTaskUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Workflow Task Users summary: List WorkflowTaskUser description: Lists all WorkflowTaskUser for the given workflowKey and workflowTaskSeq operationId: ListWorkflowTaskUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTaskUserListVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTaskUserListVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTaskUserListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflows/{workflowKey}/tasks/{workflowTaskSeq}/users/{userID}': get: tags: - Workflow Task Users summary: Get WorkflowTaskUser description: Gets WorkflowTaskUser operationId: GetWorkflowTaskUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTaskUserVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTaskUserVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTaskUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Workflow Task Users summary: Update WorkflowTaskUser description: Updates a specific WorkflowTaskUser. operationId: UpdateWorkflowTaskUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowTaskUser' text/json: schema: $ref: '#/components/schemas/WorkflowTaskUser' application/*+json: schema: $ref: '#/components/schemas/WorkflowTaskUser' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTaskUserVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTaskUserVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTaskUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Workflow Task Users summary: Delete WorkflowTaskUser description: Deletes an WorkflowTaskUser operationId: DeleteWorkflowTaskUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflows/{workflowKey}/tasks/{workflowTaskSeq}/users-batch': put: tags: - Workflow Task Users summary: Create or Update Batch WorkflowTaskUser description: 'Create or Update multiple WorkflowTaskUser at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchWorkflowTaskUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: workflowTaskSeq in: path description: WorkflowTask Seq required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/WorkflowTaskUser' text/json: schema: type: array items: $ref: '#/components/schemas/WorkflowTaskUser' application/*+json: schema: type: array items: $ref: '#/components/schemas/WorkflowTaskUser' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /workflow-types: post: tags: - Workflow Types summary: Create WorkflowType description: Creates a new WorkflowType operationId: CreateWorkflowType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowType' text/json: schema: $ref: '#/components/schemas/WorkflowType' application/*+json: schema: $ref: '#/components/schemas/WorkflowType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Workflow Types summary: List WorkflowType description: Lists all WorkflowType operationId: ListWorkflowType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTypeListVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTypeListVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTypeListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflow-types/{workflowType}': get: tags: - Workflow Types summary: Get WorkflowType description: Gets WorkflowType operationId: GetWorkflowType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowType in: path description: Workflow Type required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Workflow Types summary: Update WorkflowType description: Updates a specific WorkflowType. operationId: UpdateWorkflowType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowType in: path description: Workflow Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowType' text/json: schema: $ref: '#/components/schemas/WorkflowType' application/*+json: schema: $ref: '#/components/schemas/WorkflowType' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTypeVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTypeVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTypeVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Workflow Types summary: Delete WorkflowType description: Deletes an WorkflowType operationId: DeleteWorkflowType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowType in: path description: Workflow Type required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /workflow-types-batch: put: tags: - Workflow Types summary: Create or Update Batch WorkflowType description: 'Create or Update multiple WorkflowType at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchWorkflowType parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/WorkflowType' text/json: schema: type: array items: $ref: '#/components/schemas/WorkflowType' application/*+json: schema: type: array items: $ref: '#/components/schemas/WorkflowType' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflow-types/{workflowType}/task-options': post: tags: - Workflow Type Task Options summary: Create WorkflowTypeTaskOption description: Creates a new WorkflowTypeTaskOption operationId: CreateWorkflowTypeTaskOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowType in: path description: Workflow Type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOption' text/json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOption' application/*+json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOption' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTypeTaskOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Workflow Type Task Options summary: List WorkflowTypeTaskOption description: Lists all WorkflowTypeTaskOption for the given workflowType operationId: ListWorkflowTypeTaskOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowType in: path description: Workflow Type required: true schema: type: string - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTypeTaskOptionListVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOptionListVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOptionListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflow-types/{workflowType}/task-options/{workflowTaskOption}': get: tags: - Workflow Type Task Options summary: Get WorkflowTypeTaskOption description: Gets WorkflowTypeTaskOption operationId: GetWorkflowTypeTaskOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowType in: path description: Workflow Type required: true schema: type: string - name: workflowTaskOption in: path description: WorkflowTask Option required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTypeTaskOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Workflow Type Task Options summary: Update WorkflowTypeTaskOption description: Updates a specific WorkflowTypeTaskOption. operationId: UpdateWorkflowTypeTaskOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowType in: path description: Workflow Type required: true schema: type: string - name: workflowTaskOption in: path description: WorkflowTask Option required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOption' text/json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOption' application/*+json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOption' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowTypeTaskOptionVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOptionVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowTypeTaskOptionVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Workflow Type Task Options summary: Delete WorkflowTypeTaskOption description: Deletes an WorkflowTypeTaskOption operationId: DeleteWorkflowTypeTaskOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowType in: path description: Workflow Type required: true schema: type: string - name: workflowTaskOption in: path description: WorkflowTask Option required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflow-types/{workflowType}/task-options-batch': put: tags: - Workflow Type Task Options summary: Create or Update Batch WorkflowTypeTaskOption description: 'Create or Update multiple WorkflowTypeTaskOption at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchWorkflowTypeTaskOption parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowType in: path description: Workflow Type required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/WorkflowTypeTaskOption' text/json: schema: type: array items: $ref: '#/components/schemas/WorkflowTypeTaskOption' application/*+json: schema: type: array items: $ref: '#/components/schemas/WorkflowTypeTaskOption' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflows/{workflowKey}/users': post: tags: - Workflow Users summary: Create WorkflowUser description: Creates a new WorkflowUser operationId: CreateWorkflowUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowUser' text/json: schema: $ref: '#/components/schemas/WorkflowUser' application/*+json: schema: $ref: '#/components/schemas/WorkflowUser' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowUserVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowUserVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - Workflow Users summary: List WorkflowUser description: Lists all WorkflowUser for the given workflowKey operationId: ListWorkflowUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: page in: query description: Page schema: type: integer format: int32 default: 1 - name: pageSize in: query description: Page Size schema: type: integer format: int32 default: 100 - name: sortBy in: query description: 'Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., ''Property1:desc,Property2:asc,Property3:asc'' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.' schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowUserListVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowUserListVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowUserListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflows/{workflowKey}/users/{userID}': get: tags: - Workflow Users summary: Get WorkflowUser description: Gets WorkflowUser operationId: GetWorkflowUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowUserVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowUserVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - Workflow Users summary: Update WorkflowUser description: Updates a specific WorkflowUser. operationId: UpdateWorkflowUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowUser' text/json: schema: $ref: '#/components/schemas/WorkflowUser' application/*+json: schema: $ref: '#/components/schemas/WorkflowUser' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkflowUserVBAResponse' application/json: schema: $ref: '#/components/schemas/WorkflowUserVBAResponse' text/json: schema: $ref: '#/components/schemas/WorkflowUserVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - Workflow Users summary: Delete WorkflowUser description: Deletes an WorkflowUser operationId: DeleteWorkflowUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 - name: userID in: path description: User ID required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/workflows/{workflowKey}/users-batch': put: tags: - Workflow Users summary: Create or Update Batch WorkflowUser description: 'Create or Update multiple WorkflowUser at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchWorkflowUser parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: workflowKey in: path description: Workflow Key required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/WorkflowUser' text/json: schema: type: array items: $ref: '#/components/schemas/WorkflowUser' application/*+json: schema: type: array items: $ref: '#/components/schemas/WorkflowUser' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /zip-codes: post: tags: - ZipCodes summary: Create ZipCodes description: Creates a new ZipCodes operationId: CreateZipCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ZipCodes' text/json: schema: $ref: '#/components/schemas/ZipCodes' application/*+json: schema: $ref: '#/components/schemas/ZipCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ZipCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/ZipCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/ZipCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] get: tags: - ZipCodes summary: List ZipCodes description: 'Lists all ZipCodes ' operationId: ListZipCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ZipCodesListVBAResponse' application/json: schema: $ref: '#/components/schemas/ZipCodesListVBAResponse' text/json: schema: $ref: '#/components/schemas/ZipCodesListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] '/zip-codes/{zipCode}': get: tags: - ZipCodes summary: Get ZipCodes description: Gets ZipCodes operationId: GetZipCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: zipCode in: path description: Zip Code required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ZipCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/ZipCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/ZipCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] put: tags: - ZipCodes summary: Update ZipCodes description: Updates a specific ZipCodes. operationId: UpdateZipCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: zipCode in: path description: Zip Code required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ZipCodes' text/json: schema: $ref: '#/components/schemas/ZipCodes' application/*+json: schema: $ref: '#/components/schemas/ZipCodes' required: true responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ZipCodesVBAResponse' application/json: schema: $ref: '#/components/schemas/ZipCodesVBAResponse' text/json: schema: $ref: '#/components/schemas/ZipCodesVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] delete: tags: - ZipCodes summary: Delete ZipCodes description: Deletes an ZipCodes operationId: DeleteZipCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string - name: zipCode in: path description: Zip Code required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] /zip-codes-batch: put: tags: - ZipCodes summary: Create or Update Batch ZipCodes description: 'Create or Update multiple ZipCodes at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.' operationId: UpdateBatchZipCodes parameters: - name: vbasoftware-database in: header description: Target database required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ZipCodes' text/json: schema: type: array items: $ref: '#/components/schemas/ZipCodes' application/*+json: schema: type: array items: $ref: '#/components/schemas/ZipCodes' required: true responses: '207': description: Success content: text/plain: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' application/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' text/json: schema: $ref: '#/components/schemas/MultiCodeResponseListVBAResponse' '401': description: Unauthorized security: - apiKeyAuth: [ ] bearerAuth: [ ] components: schemas: APCCodes: required: - apC_Code type: object properties: apC_Code: maxLength: 8 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false APCCodesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/APCCodes' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false APCCodesVBAResponse: type: object properties: data: $ref: '#/components/schemas/APCCodes' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false APCSchedule: required: - apC_Schedule type: object properties: apC_Schedule: maxLength: 16 minLength: 1 type: string description: Name for the APC schedule. description: maxLength: 512 type: string description: Description of the APC schedule. nullable: true additionalProperties: false APCScheduleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/APCSchedule' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false APCScheduleVBAResponse: type: object properties: data: $ref: '#/components/schemas/APCSchedule' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false APCWeight: required: - apC_Code - apC_Schedule - effective_Date type: object properties: apC_Schedule: maxLength: 16 minLength: 1 type: string apC_Code: maxLength: 8 minLength: 1 type: string effective_Date: type: string format: date-time entry_Date: type: string format: date-time nullable: true entry_User: maxLength: 20 type: string nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time nullable: true update_User: maxLength: 20 type: string nullable: true weight: type: number format: double nullable: true additionalProperties: false APCWeightListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/APCWeight' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false APCWeightVBAResponse: type: object properties: data: $ref: '#/components/schemas/APCWeight' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ActiveSubscriber: type: object properties: subscriberId: type: string nullable: true memberSeq: type: string nullable: true birthDate: type: string format: date-time nullable: true firstName: type: string nullable: true lastName: type: string nullable: true planDescription: type: string nullable: true tierDescription: type: string nullable: true startDate: type: string format: date-time endDate: type: string format: date-time nullable: true additionalProperties: false ActiveSubscriberListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ActiveSubscriber' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AddEnrollmentRequest: required: - requesting_User_ID type: object properties: requesting_User_ID: maxLength: 20 minLength: 1 type: string description: User ID of the person making this request. addMembers: type: boolean description: 'Flag indicating if members should be enrolled in addition to the subscriber. If false, only subscriber is enrolled; If true, members + subscriber is enrolled.' subEnrollment: $ref: '#/components/schemas/SubEnrollment' additionalProperties: false AdjudicateBenefitMatchDetail: type: object properties: batch_Number: type: integer format: int32 nullable: true batch_Claim: type: integer format: int32 nullable: true claim_Seq: type: string nullable: true adjustment_Seq: type: string nullable: true service_Date: type: string format: date-time nullable: true benefit_Code: type: string nullable: true place_Of_Service_Match: type: integer format: int32 nullable: true procedure_Code_Match: type: integer format: int32 nullable: true diagnostic_Code_Match: type: integer format: int32 nullable: true provider_Type_Match: type: integer format: int32 nullable: true specialty_Match: type: integer format: int32 nullable: true network_Match: type: integer format: int32 nullable: true relationship_Match: type: integer format: int32 nullable: true gender_Match: type: integer format: int32 nullable: true service_Age_Match: type: integer format: int32 nullable: true received_Age_Match: type: integer format: int32 nullable: true months_Enrolled_Match: type: integer format: int32 nullable: true days_Enrolled_Match: type: integer format: int32 nullable: true modifier_Match: type: integer format: int32 nullable: true billed_Match: type: integer format: int32 nullable: true billing_Taxonomy_Match: type: integer format: int32 nullable: true rendering_Taxonomy_Match: type: integer format: int32 nullable: true service_Facility_Taxonomy_Match: type: integer format: int32 nullable: true benefit_Description: type: string nullable: true match_Count: type: integer format: int32 nullable: true total_Match_Count: type: integer format: int32 benefit_Effective_Date: type: string format: date-time nullable: true benefit_Term_Date: type: string format: date-time nullable: true federal_ID_Match: type: integer format: int32 nullable: true additionalProperties: false AdjudicateBenefitMatchDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AdjudicateBenefitMatchDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AdmissionTypePlace: required: - admission_Type - place_Of_Service type: object properties: admission_Type: maxLength: 8 minLength: 1 type: string place_Of_Service: maxLength: 8 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true excluded_Admission_Type: type: boolean nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false AdmissionTypePlaceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AdmissionTypePlace' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AdmissionTypePlaceVBAResponse: type: object properties: data: $ref: '#/components/schemas/AdmissionTypePlace' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AmountDetails: type: object properties: key: type: string nullable: true value: type: string nullable: true additionalProperties: false AmountDetailsListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AmountDetails' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AmountDetailsVBAResponse: type: object properties: data: $ref: '#/components/schemas/AmountDetails' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ArmorCodeExCode: required: - armor_Code - armorCodeExCode_Key - ex_Code type: object properties: armorCodeExCode_Key: type: integer description: 'Unique identifier for each record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 armor_Code: maxLength: 16 minLength: 1 type: string description: Armor Code From Value to be matched with an Explanation Code. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 minLength: 1 type: string description: Explanation Code Value to be matched with an Armor Code Range. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ArmorCodeExCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ArmorCodeExCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ArmorCodeExCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ArmorCodeExCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Auth: required: - closed - new_Or_Extended - previous_Treatment - tPlan_DownLoaded - tPlan_Printed - urgent type: object properties: auth_Number: maxLength: 20 type: string description: Unique identifier assigned to the authorization. nullable: true actual_From: type: string description: Date when authorization usage begins/began. format: date-time nullable: true actual_Location: maxLength: 4 type: string description: Location where the authorization was used. nullable: true actual_Thru: type: string description: Date when authorization usage ends/ended. format: date-time nullable: true additional_Visits: type: number description: No longer in use. This would track if an Auth had been adjusted to increase the number of approved visits. This is now done through the Auth Adjustment process where a new Auth is created referencing the original Auth. format: double nullable: true amount_Actual: type: number description: Total approved amount that has been used. format: double nullable: true amount_Approved: type: number description: Approved amount of the authorization. format: double nullable: true amount_Denied: type: number description: Denied amount of the authorization. format: double nullable: true amount_Requested: type: number description: Requested amount of the authorization. format: double nullable: true approved_By: maxLength: 50 type: string description: 'User that either approved, pended, or denied the authorization.' nullable: true approved_Date: type: string description: 'Date when the authorization was approved, denied, or pended as specified by the status field.' format: date-time nullable: true approved_Frequency: maxLength: 16 type: string description: Authorization frequency that is/was approved. nullable: true approved_From: type: string description: Date when the authorization approval starts/started. format: date-time nullable: true approved_Location: maxLength: 4 type: string description: Approved location of the authorization. nullable: true approved_Thru: type: string description: Date when the authorization approval expires/expired. format: date-time nullable: true assigned_User: maxLength: 20 type: string description: User that the authorization was assigned to. nullable: true audit_Flag: maxLength: 1 type: string description: Information field used in custom reporting. nullable: true auth_Code: maxLength: 8 type: string description: Code that indicates the authorization status. nullable: true auth_Type: maxLength: 8 type: string description: Indicates the type of authorization. Auth types can be configured within 'Auth Configuration'. nullable: true auto_Accident: maxLength: 1 type: string description: Check this box to indicate that the authorization is related to an automotive accident. nullable: true bodyCode_ID: maxLength: 8 type: string description: No longer in use. nullable: true careManager_Key: type: integer description: ID of the Care Manager associated with the auth. format: int32 nullable: true case_Index_Actual: maxLength: 2 type: string description: Informational field used to identify the case index. nullable: true case_Index_Approved: maxLength: 2 type: string description: Informational field used to identify the case index. nullable: true case_Index_Denied: maxLength: 2 type: string description: Informational field used to identify the case index. nullable: true case_Index_Requested: maxLength: 2 type: string description: Informational field used to identify the case index. nullable: true case_Number: maxLength: 64 type: string description: Informational field used to house the case number. nullable: true cityCode_ID: maxLength: 8 type: string description: No longer in use. nullable: true closed: type: boolean description: 'Field no longer used. This is repalced by the Status field. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' drG_Category: maxLength: 8 type: string description: Identifies the category of the selected DRG Code. nullable: true drG_Code: maxLength: 8 type: string description: Specifies a DRG code that is to be associated with the authorization. nullable: true daily_Living: type: integer description: Identifies that the authoization is associated with a claim that is affecting the patient's daily living. format: int32 nullable: true denied_From: type: string description: Date when the authorization denial starts/started. format: date-time nullable: true denied_Thru: type: string description: Date when the authorization denial expires/expired. format: date-time nullable: true discharge_Date: type: string description: Date when the patient was discharged. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true federal_ID: maxLength: 20 type: string description: Unique identifier assigned to the Provider associated with the Auth. This field can be populated by right-clicking and selecting 'Lookup' from the context menu. nullable: true ivR_Flag: maxLength: 1 type: string description: Indicates that the Auth was Initiated via IVR. nullable: true injury_Date: type: string description: Date when the injury occurred. format: date-time nullable: true member_Seq: maxLength: 2 type: string description: Sequential identifier assigned to the Member. nullable: true monthly_Amount: type: number description: Information field used in custom reporting. format: double nullable: true narrative: type: string description: Field no longer used. For Notes/Comments/Narrative information you would use the Note Services area. nullable: true new_Or_Extended: type: boolean description: 'Indicates that the associated authorization is a new authorization or an extension of the original authorization. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' notes: type: string description: Field that allows the User to add any additional information to the authorization. nullable: true ordered_By_ID: maxLength: 20 type: string description: ID of the Provider who ordered this auth. nullable: true ordered_By_Name: maxLength: 512 type: string description: Name of the Provider who ordered this auth. nullable: true other_Coverage_Primary: maxLength: 1 type: string description: Information field used in custom reporting. nullable: true other_Insurance: maxLength: 2 type: string description: Check this box to indicate that the associated Member has other insurance. nullable: true payee_ID: maxLength: 20 type: string description: ID of the Payee associated with the auth. nullable: true plan_ID: maxLength: 20 type: string description: Unique identifier assigned to the plan. nullable: true previous_Auth: maxLength: 20 type: string description: This field is no longer used as it has been replaced by the the Auth Adjustment process where an AuthReference record is created instead. nullable: true previous_Treatment: type: boolean description: 'Check this box to indicate that previous treatment had been administered. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' prior_Auth: maxLength: 20 type: string description: References Prior Auth nullable: true provider_ID: maxLength: 20 type: string description: Unique identifier assigned to the Provider associated with the Auth. This field can be populated by right-clicking and selecting 'Lookup' from the context menu. nullable: true radiating_Pain: type: integer description: Identifies that the authoization is associated with a claim where the patient is experiencing radiating pain. format: int32 nullable: true range_Of_Motion: type: integer description: Identifies that the authoization is associated with a claim that is affecting the patient's range of motion. format: int32 nullable: true received_Date: type: string description: Date when the authorization was received. format: date-time nullable: true referred_By_ID: maxLength: 20 type: string description: Unique identifier assigned to the Provider who is referring. This field can be populated by right-clicking and selecting 'Lookup' from the context menu. nullable: true referred_By_Name: maxLength: 512 type: string description: Name of the referring Provider. This field is automatically populated by the 'Referred By ID' field. nullable: true region: maxLength: 1 type: string description: Information field used in custom reporting. nullable: true reinsNotification_Date: type: string description: Date when the Reinsurance Notification report was run. Process automation will be prompted to send the auth reinsurance notification on this date. format: date-time nullable: true requested_Frequency: maxLength: 16 type: string description: Authorization frequency that is/was requested. nullable: true requested_From: type: string description: Date when the authorization is/was requested to be effective. format: date-time nullable: true requested_Location: maxLength: 4 type: string description: Requested location of the authorization. nullable: true requested_Thru: type: string description: Date when the authorization is/was requested to expire. format: date-time nullable: true service_Code: maxLength: 5 type: string description: Code used to identify the service type associated with the authorization. nullable: true service_Type: maxLength: 10 type: string description: Type of service associated with the authorization. nullable: true status: maxLength: 8 type: string description: Identifies the current status of the authorization. nullable: true subscriber_ID: maxLength: 9 type: string description: Unique identifier assigned to the Subscriber associated with the Auth. This field can be populated by right-clicking and selecting 'Lookup' from the context menu. nullable: true tPlan_DownLoaded: type: boolean description: 'Indicates if the Treatment Plan was downloaded from the application. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' tPlan_DownLoaded_Date: type: string description: Indicates the date the Treatment Plan was downloaded from the application. format: date-time nullable: true tPlan_DownLoaded_User: maxLength: 20 type: string description: Indicates the user what downloaded the Treatment Plan from the application. nullable: true tPlan_Printed: maxLength: 1 minLength: 1 type: string description: Flag indicating if this Auth has been printed as a Treatment Plan. tPlan_Printed_Date: type: string description: The date this Auth has been printed as a Treatment Plan. format: date-time nullable: true total_Actual: type: number description: No longer in use. format: double nullable: true total_Approved: type: number description: No longer in use. format: double nullable: true total_Requested: type: number description: No longer in use. format: double nullable: true total_Unit_Type: maxLength: 16 type: string description: No longer in use. nullable: true treatment_Type: maxLength: 8 type: string description: Indicates the type of treatment that is being authorized. nullable: true type_Of_Service: maxLength: 5 type: string description: No longer in use. nullable: true unit_Type: maxLength: 16 type: string description: Unit type that is used for the associated service. Unit types can be configured in 'Auth Configuration'. nullable: true units_Actual: type: number description: Total number of approved units that have been used. format: double nullable: true units_Approved: type: number description: Number of units approved as part of the authorization. format: double nullable: true units_Denied: type: number description: Number of units denied as part of the authorization. format: double nullable: true units_Requested: type: number description: Number of units requested as part of the authorization. format: double nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true urgent: type: boolean description: 'Check this box to indicate that the authorization request is urgent. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' visits_Actual: type: number description: Number of visits used as part of the authorization. format: double nullable: true visits_Approved: type: number description: Number of visits approved as part of the authorization. format: double nullable: true visits_Requested: type: number description: Number of visits requested as part of the authorization. format: double nullable: true visits_To_Date: type: number description: Number of visits that have been used up to the current date. format: double nullable: true work_Related: maxLength: 1 type: string description: Check this box to indicate that the authorization is related to work. nullable: true additionalProperties: false AuthAction: required: - auth_Action type: object properties: auth_Action: maxLength: 1 minLength: 1 type: string description: 'Specifies what action will be applied by the associated status code: Approved - full authorization amount will be approved. Denied - full authorization amount will be denied. Pended - requested authorization amount has been pended for review. Voided - authorization has been removed. Partial Approval - only a partial amount of the authorization has been approved.' description: maxLength: 128 type: string description: Description of the authorization status tied to the associated code. nullable: true additionalProperties: false AuthActionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AuthAction' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthAdjustment: required: - auth_Number - copyDiagCodes - copyProcCodes - recalcIBNR type: object properties: auth_Number: maxLength: 20 minLength: 1 type: string description: Unique identifier assigned to the authorization. approved_From: type: string description: The new date when the authorization approval starts/started. format: date-time nullable: true approved_Thru: type: string description: The new date when the authorization approval expires/expired format: date-time nullable: true recalcIBNR: type: boolean description: Indicates if the IBNR should be recalculated after the Auth Adjustment copyProcCodes: type: boolean description: Indicates if the ProcCodes should be copied after Auth Adjustment copyDiagCodes: type: boolean description: Indicates if the DiagCodes should be copied after Auth Adjustment procedure_Code: type: string description: 'When CopyProcCodes is NOT used, you can pass a single Procedure Code here to populate the adjusted auth with a default Procedure Code value.' nullable: true additionalProperties: false AuthCode: required: - auth_Code type: object properties: auth_Code: maxLength: 8 minLength: 1 type: string description: Code that indicates the authorization status. auth_Action: maxLength: 1 type: string description: 'Specifies what action will be applied by the associated status code: Approved - full authorization amount will be approved. Denied - full authorization amount will be denied. Pended - requested authorization amount has been pended for review. Voided - authorization has been removed. Partial Approval - only a partial amount of the authorization has been approved.' nullable: true description: maxLength: 64 type: string description: Description of the authorization status tied to the associated code. nullable: true additionalProperties: false AuthCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/AuthCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthDiagCodes: required: - auth_Number - diagnostic_Code - diagnostic_Code_Type - disable_Provider_Match type: object properties: auth_Number: maxLength: 20 minLength: 1 type: string description: Unique identifier assigned to the authorization. diagnostic_Code: maxLength: 8 minLength: 1 type: string description: Unique identifier assigned to the diagnosis that will be tied to the authorization. This can be selected by right-clicking within the field and selecting 'Lookup' from the context menu. diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string description: Identifies the ICD version that is associated with the diagnosis code. disable_Provider_Match: type: boolean description: Checking this box means that adjudication will not require a match on the diagnosis code when automatically assigning this auth. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true primary_Diag: maxLength: 1 type: string description: Indicates that the associated diagnosis is the primary diagnosis. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false AuthDiagCodesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AuthDiagCodes' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthDiagCodesVBAResponse: type: object properties: data: $ref: '#/components/schemas/AuthDiagCodes' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Auth' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthProcCodes: required: - auth_Number - authProcCodes_Key - exclude_Modifier_Match type: object properties: authProcCodes_Key: type: integer description: Unique identifier for each record. format: int32 auth_Number: maxLength: 20 minLength: 1 type: string description: Unique identifier assigned to the authorization. exclude_Modifier_Match: type: boolean description: Checking this box means that adjudication will not require a match on the procedure modifiers when automatically assigning this auth. modifier1: maxLength: 8 type: string description: Required modifier for adjudication to match this authorization to a claim. nullable: true modifier2: maxLength: 8 type: string description: Required modifier for adjudication to match this authorization to a claim. nullable: true modifier3: maxLength: 8 type: string description: Required modifier for adjudication to match this authorization to a claim. nullable: true modifier4: maxLength: 8 type: string description: Required modifier for adjudication to match this authorization to a claim. nullable: true procedure_Cluster: maxLength: 32 type: string description: Allows the User to apply a procedure cluster to the procedure code line. This can be selected by right-clicking within the field and selecting 'Lookup' from the context menu. nullable: true procedure_Code: maxLength: 8 type: string description: Unique identifier assigned to the procedure that will be tied to the authorization. This can be selected by right-clicking within the field and selecting 'Lookup' from the context menu. nullable: true units_Actual: type: number description: Total number of approved units of the associated procedure that have been used. format: double nullable: true units_Approved: type: number description: Approved number of units of the associated procedure. format: double nullable: true units_Requested: type: number description: Requested number of units of the associated procedure. format: double nullable: true additionalProperties: false AuthProcCodesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AuthProcCodes' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthProcCodesVBAResponse: type: object properties: data: $ref: '#/components/schemas/AuthProcCodes' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthReference: required: - original_Auth_Number - reference_Type - referenced_Auth_Number type: object properties: original_Auth_Number: maxLength: 20 minLength: 1 type: string description: This is the Auth Number being referenced by Referenced Auth Number referenced_Auth_Number: maxLength: 20 minLength: 1 type: string description: This is the Auth Number being referenced by Original Auth Number entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true reference_Date: type: string description: The date this reference was processed by the system. format: date-time nullable: true reference_Type: maxLength: 2 minLength: 1 type: string description: This indicates the type of Reference being made. The only Reference_Type value currently in use is "A" for "Adjustment". update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false AuthReferenceVBAResponse: type: object properties: data: $ref: '#/components/schemas/AuthReference' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthReview: required: - auth_Number - authReview_Key type: object properties: authReview_Key: type: integer description: Unique identifier for each record. format: int32 auth_Number: maxLength: 20 minLength: 1 type: string description: Unique identifier assigned to the authorization. review_Comment: maxLength: 512 type: string description: Allows the reviewing User to add any additional information to the review. nullable: true review_Date: type: string description: Date when the authorization was reviewed. format: date-time nullable: true review_Level: maxLength: 32 type: string description: Level of the review. This is configurable in 'Auth Configuration'. nullable: true review_Severity: maxLength: 32 type: string description: Severity of the review. This is configurable in 'Auth Configuration'. nullable: true review_Status: maxLength: 32 type: string description: Status of the review. This is configurable in 'Auth Configuration'. nullable: true review_Type: maxLength: 32 type: string description: Type of the review. This is configurable in 'Auth Configuration'. nullable: true review_Urgency_Type: maxLength: 32 type: string description: Urgency type of the review. This is configurable in 'Auth Configuration'. nullable: true review_User: maxLength: 20 type: string description: ID of the User who reviewed the authorization. nullable: true additionalProperties: false AuthReviewLevel: required: - review_Level type: object properties: review_Level: maxLength: 32 minLength: 1 type: string description: Name of the review level. description: maxLength: 512 type: string description: Description of the associated review level. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false AuthReviewLevelListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AuthReviewLevel' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthReviewLevelVBAResponse: type: object properties: data: $ref: '#/components/schemas/AuthReviewLevel' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthReviewListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AuthReview' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthReviewSeverity: required: - review_Severity type: object properties: review_Severity: maxLength: 32 minLength: 1 type: string description: Name of the review severity. description: maxLength: 512 type: string description: Description of the associated review severity. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false AuthReviewSeverityListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AuthReviewSeverity' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthReviewSeverityVBAResponse: type: object properties: data: $ref: '#/components/schemas/AuthReviewSeverity' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthReviewStatus: required: - review_Status type: object properties: review_Status: maxLength: 32 minLength: 1 type: string description: Name of the review status. description: maxLength: 512 type: string description: Description of the associated review status. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false AuthReviewStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AuthReviewStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthReviewStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/AuthReviewStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthReviewType: required: - review_Type type: object properties: review_Type: maxLength: 32 minLength: 1 type: string description: Name of the review type. description: maxLength: 512 type: string description: Description of the review type. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false AuthReviewTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AuthReviewType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthReviewTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/AuthReviewType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthReviewUrgencyType: required: - review_Urgency_Type type: object properties: review_Urgency_Type: maxLength: 32 minLength: 1 type: string description: Name of the review urgency type. description: maxLength: 512 type: string description: Description of the review urgency type. nullable: true additionalProperties: false AuthReviewUrgencyTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AuthReviewUrgencyType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthReviewUrgencyTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/AuthReviewUrgencyType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthReviewVBAResponse: type: object properties: data: $ref: '#/components/schemas/AuthReview' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthType: required: - auth_Type - disable_Provider_Match - ignore_Procedure_Modifier type: object properties: auth_Type: maxLength: 8 minLength: 1 type: string description: Name of the auth type. default_Unit_Type: maxLength: 16 type: string description: Specifies the default type of unit that will be used for this auth type. This unit will automatically be used on the auth screen when the associated auth type is selected. nullable: true description: maxLength: 32 type: string description: Description of the auth type. nullable: true disable_Provider_Match: type: boolean description: 'Checking this box will remove the requirement of a Provider match when the associated auth type is used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ignore_Procedure_Modifier: type: boolean description: 'Checking this box will remove the requirement of procedure modifier matching when the associated auth type is used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false AuthTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AuthType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthTypePlace: required: - auth_Type - place_Of_Service type: object properties: auth_Type: maxLength: 8 minLength: 1 type: string description: Name of the auth type that the place of service will be tied to. place_Of_Service: maxLength: 8 minLength: 1 type: string description: Specifies the place of service that will be tied to the auth type. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true excluded: type: boolean description: Identifies that the selected place of service will be excluded from the auth type. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false AuthTypePlaceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/AuthTypePlace' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthTypePlaceVBAResponse: type: object properties: data: $ref: '#/components/schemas/AuthTypePlace' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/AuthType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthVBAResponse: type: object properties: data: $ref: '#/components/schemas/Auth' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false AuthenticationResult: type: object properties: accessToken: type: string description: The ID token. nullable: true idToken: type: string description: The ID token. nullable: true refreshToken: type: string description: The ID token. nullable: true expiresIn: type: integer description: The expiration period of the authentication result in seconds. format: int32 additionalProperties: false BenefitCategory: required: - benefit_Category type: object properties: benefit_Category: maxLength: 32 minLength: 1 type: string description: Unique identifier assigned to the Benefit Category. description: maxLength: 128 type: string description: Description of the associated Benefit Category. nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false BenefitCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/BenefitCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BenefitCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/BenefitCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BenefitCodes: required: - allow_Flat_Tax - benefit_Code - medicare - pend_Flag type: object properties: benefit_Code: maxLength: 10 minLength: 1 type: string allow_Flat_Tax: type: boolean benefit_Category: maxLength: 32 type: string nullable: true benefit_Description: maxLength: 64 type: string nullable: true default_Unit_Type: maxLength: 16 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true hipaA_Code: maxLength: 8 type: string nullable: true invalid_Diag_Ex_Code: maxLength: 6 type: string nullable: true invalid_Procedure_Ex_Code: maxLength: 6 type: string nullable: true invalid_Prov_Type_Ex_Code: maxLength: 6 type: string nullable: true invalid_Specialty_Ex_Code: maxLength: 6 type: string nullable: true medicare: maxLength: 1 minLength: 1 type: string pend_Ex_Code: maxLength: 6 type: string nullable: true pend_Flag: maxLength: 1 minLength: 1 type: string require_Type_Of_Svc: maxLength: 1 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false BenefitCodesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/BenefitCodes' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BenefitCodesVBAResponse: type: object properties: data: $ref: '#/components/schemas/BenefitCodes' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BenefitDiagCodes: required: - benefit_Code - diagnostic_Code_Type - exclude - from_Diag_Code type: object properties: benefit_Code: maxLength: 10 minLength: 1 type: string description: References the BenefitCodes.Benefit_Code from the parent table. diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string description: 'Specifies the numbering system used for the selected Diagnosis Codes. Note: This field is marked as NOT NULL in the database and therefore required by the API.' from_Diag_Code: maxLength: 8 minLength: 1 type: string description: First Diagnosis Code for the specified range. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exclude: type: boolean description: 'Indicates whether the specified range of codes is Included or Excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.' thru_Diag_Code: maxLength: 8 type: string description: Last Diagnosis Code for the specified range. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false BenefitDiagCodesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/BenefitDiagCodes' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BenefitDiagCodesVBAResponse: type: object properties: data: $ref: '#/components/schemas/BenefitDiagCodes' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BenefitPlace: required: - benefit_Code - exclude - place_Code type: object properties: benefit_Code: maxLength: 10 minLength: 1 type: string description: References the BenefitCodes.Benefit_Code from the parent table. place_Code: maxLength: 4 minLength: 1 type: string description: Specifies the place of service that the User wishes to either include or exclude as part of the benefit. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exclude: type: boolean description: 'Indicates whether the specified place of service is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false BenefitPlaceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/BenefitPlace' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BenefitPlaceVBAResponse: type: object properties: data: $ref: '#/components/schemas/BenefitPlace' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BenefitProcedures: required: - benefit_Code - exclude - from_Procedure type: object properties: benefit_Code: maxLength: 10 minLength: 1 type: string description: References the BenefitCodes.Benefit_Code from the parent table. from_Procedure: maxLength: 8 minLength: 1 type: string description: First Procedure Code for the specified range. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exclude: type: boolean description: 'Indicates whether the specified range of codes is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_From_Procedure: maxLength: 8 type: string description: No longer in use. nullable: true override_Thru_Procedure: maxLength: 8 type: string description: No longer in use. nullable: true thru_Procedure: maxLength: 8 type: string description: Last Procedure Code for the specified range. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false BenefitProceduresListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/BenefitProcedures' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BenefitProceduresVBAResponse: type: object properties: data: $ref: '#/components/schemas/BenefitProcedures' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BenefitProviderTypes: required: - benefit_Code - exclude - provider_Type type: object properties: benefit_Code: maxLength: 10 minLength: 1 type: string description: References the BenefitCodes.Benefit_Code from the parent table. provider_Type: maxLength: 10 minLength: 1 type: string description: Specifies the Provider type that the User wishes to either include or exclude as part of the benefit. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exclude: type: boolean description: 'Indicates whether the specified code is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false BenefitProviderTypesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/BenefitProviderTypes' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BenefitProviderTypesVBAResponse: type: object properties: data: $ref: '#/components/schemas/BenefitProviderTypes' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BenefitSpecialty: required: - benefit_Code - exclude - specialty_Code type: object properties: benefit_Code: maxLength: 10 minLength: 1 type: string description: References the BenefitCodes.Benefit_Code from the parent table. specialty_Code: maxLength: 10 minLength: 1 type: string description: Specifies the Provider specialty that the User wishes to either include or exclude as part of the benefit. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exclude: type: boolean description: 'Indicates whether the specified code is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false BenefitSpecialtyListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/BenefitSpecialty' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BenefitSpecialtyVBAResponse: type: object properties: data: $ref: '#/components/schemas/BenefitSpecialty' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BillType: required: - inpatient - type_Of_Bill type: object properties: type_Of_Bill: maxLength: 8 minLength: 1 type: string description: Unique identifier for the Type of Bill description: maxLength: 128 type: string description: Description of Type of Bill nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true inpatient: type: boolean description: Inpatient identifies the Type of Bill used for inpatient bills update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false BillTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/BillType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BillTypePlace: required: - place_Of_Service - type_Of_Bill type: object properties: type_Of_Bill: maxLength: 8 minLength: 1 type: string description: Unique identifier for the Type of Bill place_Of_Service: maxLength: 8 minLength: 1 type: string description: Place Code for this Type of Bill entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true excluded_Type_Of_Bill: type: boolean description: Excludes this Place Code for this Type of Bill nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false BillTypePlaceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/BillTypePlace' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BillTypePlaceVBAResponse: type: object properties: data: $ref: '#/components/schemas/BillTypePlace' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BillTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/BillType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BillingBasis: required: - billing_Basis type: object properties: billing_Basis: maxLength: 1 minLength: 1 type: string description: No longer in use. description: maxLength: 64 type: string description: No longer in use. nullable: true entry_Date: type: string description: No longer in use. format: date-time entry_User: maxLength: 20 type: string description: No longer in use. nullable: true update_Date: type: string description: No longer in use. format: date-time update_User: maxLength: 20 type: string description: No longer in use. nullable: true additionalProperties: false BillingBasisListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/BillingBasis' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BillingBasisVBAResponse: type: object properties: data: $ref: '#/components/schemas/BillingBasis' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BillingCycle: required: - billing_Cycle_ID - individual_Billing type: object properties: billing_Cycle_ID: maxLength: 2 minLength: 1 type: string description: Unique identifier for the Billing Cycle cycle_Factor: type: number description: Cycle Factor is a multiplier applied to the rate format: double nullable: true cycle_Frequency: type: integer description: Cycle Frequency is the number of times the date type occurs format: int32 nullable: true cycle_Type: maxLength: 2 type: string description: Cycle Type is the date type of the Billing Cycle nullable: true description: maxLength: 30 type: string description: Description of the Billing Cycle nullable: true discount_Pct: type: number description: No longer in use. format: double nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true individual_Billing: type: boolean description: 'Individual Billing identifies the Billing Cycle for Subscriber level invoices Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' months: type: integer description: Months on invoices with this Billing Cycle format: int32 nullable: true times_Per_Year: type: integer description: No longer in use. format: int32 nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false BillingCycleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/BillingCycle' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BillingCycleVBAResponse: type: object properties: data: $ref: '#/components/schemas/BillingCycle' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BillingRefund: type: object properties: invoice_Key: type: integer format: int32 nullable: true group_ID: type: string nullable: true division_ID: type: string nullable: true subscriber_ID: type: string nullable: true premRate_Key: type: integer format: int32 nullable: true amount: type: number format: double nullable: true amount_Received: type: number format: double nullable: true volume: type: number format: double nullable: true payee_Level: type: string nullable: true payor_ID: type: string nullable: true account_Key: type: integer format: int32 nullable: true premPayment_Key: type: integer format: int32 nullable: true refund_Amount: type: number format: double nullable: true payment_ID: type: string nullable: true payment_Name: type: string nullable: true invoice_Level: type: string nullable: true user_ID: type: string nullable: true additionalProperties: false BooleanVBAResponse: type: object properties: data: type: boolean error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Brokerage: required: - brokerage1 type: object properties: brokerage1: maxLength: 256 minLength: 1 type: string description: Brokerage that can be associated with a group entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false BrokerageListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Brokerage' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false BrokerageVBAResponse: type: object properties: data: $ref: '#/components/schemas/Brokerage' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CLIACertificate: required: - certificate_ID type: object properties: certificate_ID: type: integer description: 'Idenfitier of the CLIA certificate. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 certificate_Type: maxLength: 32 type: string description: Indicates the type of CLIA certificate. nullable: true description: maxLength: 128 type: string description: Description of the associated CLIA certificate. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CLIACertificateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CLIACertificate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CLIACertificateProcedureCode: required: - certificate_ID - effective_Date - procedure_Code type: object properties: certificate_ID: type: integer format: int32 procedure_Code: maxLength: 8 minLength: 1 type: string effective_Date: type: string format: date-time end_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CLIACertificateProcedureCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CLIACertificateProcedureCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CLIACertificateProcedureCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CLIACertificateProcedureCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CLIACertificateProvider: required: - certificate_ID - effective_Date - provider_ID type: object properties: certificate_ID: type: integer format: int32 provider_ID: maxLength: 20 minLength: 1 type: string effective_Date: type: string format: date-time end_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CLIACertificateProviderListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CLIACertificateProvider' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CLIACertificateProviderVBAResponse: type: object properties: data: $ref: '#/components/schemas/CLIACertificateProvider' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CLIACertificateVBAResponse: type: object properties: data: $ref: '#/components/schemas/CLIACertificate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false COBRAPlanCriteria: type: object properties: plan_ID: type: string nullable: true tier: type: string nullable: true additionalProperties: false COMMCHECKS: type: object properties: selected: type: integer format: int32 check_Number: type: string nullable: true check_Date: type: string format: date-time nullable: true check_Type: type: string nullable: true name_On_Check: type: string nullable: true check_Status: type: string nullable: true amount_Due: type: number format: double nullable: true paid_Amount: type: number format: double nullable: true create_Date: type: string format: date-time create_User: type: string nullable: true check_Batch: type: integer format: int32 payee_ID: type: string nullable: true payor_ID: type: string nullable: true account_Key: type: integer format: int32 nullable: true pay_To_ID: type: string nullable: true address_On_Check: type: string nullable: true address2_On_Check: type: string nullable: true city_On_Check: type: string nullable: true state_On_Check: type: string nullable: true zip_On_Check: type: string nullable: true send_Check_To: type: string nullable: true name_On_Address: type: string nullable: true payment_Method: type: string nullable: true signature_Key: type: integer format: int32 nullable: true check_Paid_Date: type: string format: date-time nullable: true account_Balance: type: number format: double nullable: true additionalProperties: false CallTracking: required: - call_Key type: object properties: call_Key: type: integer description: 'ID assigned to the Call. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 auth_Number: maxLength: 20 type: string description: Authorization number of the claim associated with the call. nullable: true call_Destination: maxLength: 32 type: string description: Identifies the location where the call was received. 'Call Destinations' are configured within 'Call Tracking Configuration'. nullable: true call_Length: type: integer description: Identifies the length of the call. format: int32 nullable: true call_Start: type: string description: Identifies the date and time when the call was started. format: date-time nullable: true call_Status: maxLength: 32 type: string description: Identifies the status of the call. 'Call Statuses' are configured within 'Call Tracking Configuration'. nullable: true call_Type: maxLength: 32 type: string description: Identifies the type of call. This usually identifies the subject or purpose of the call. 'Call Types' are configured within 'Call Tracking Configuration'. nullable: true caller_Type: maxLength: 32 type: string description: Identifies the type of Caller. 'Caller Types' are configured within 'Call Tracking Configuration'. nullable: true contacts_List: type: boolean description: Indicates that the associated Caller may be found within the 'Contacts Folder'. nullable: true email_Address: maxLength: 128 type: string description: Email address of the Caller. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true extension: maxLength: 10 type: string description: Extension of the Caller's phone number. nullable: true fax_Number: maxLength: 20 type: string description: Fax number of the Caller. nullable: true first_Name: maxLength: 64 type: string description: First name of the Caller. nullable: true general_Notes: maxLength: 1000 type: string description: Text area where the User may enter any relevant notes regarding the call. nullable: true last_Name: maxLength: 64 type: string description: Last name of the Caller. nullable: true organization: maxLength: 128 type: string description: Organization that the Caller belongs to. nullable: true phone_Country_Code: maxLength: 8 type: string description: Country code of the Caller's phone number. nullable: true phone_Number: maxLength: 20 type: string description: Phone number of the Caller. nullable: true provider_ID: maxLength: 20 type: string description: ID of the Provider associated with the call. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CallTrackingCallDestination: required: - call_Destination - default_Destination type: object properties: call_Destination: maxLength: 32 minLength: 1 type: string description: Name of the 'Call Destination'. default_Destination: type: boolean description: 'Sets the associated ''Call Destination'' as the default. New calls will automatically have this destination listed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 64 type: string description: Description of the 'Call Destination'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CallTrackingCallDestinationListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CallTrackingCallDestination' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingCallDestinationVBAResponse: type: object properties: data: $ref: '#/components/schemas/CallTrackingCallDestination' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingCallStatus: required: - call_Status - default_Status type: object properties: call_Status: maxLength: 32 minLength: 1 type: string description: Name for the 'Call Status'. default_Status: type: boolean description: 'Sets the associated ''Call Status'' as the default. New calls will automatically have this ''Call Status'' listed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 64 type: string description: Description of the 'Call Status'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CallTrackingCallStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CallTrackingCallStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingCallStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/CallTrackingCallStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingCallType: required: - call_Type - default_Type type: object properties: call_Type: maxLength: 32 minLength: 1 type: string description: Name of the 'Call Type'. default_Type: type: boolean description: 'Sets the associated ''Call Status'' as the default. New calls will automatically have this ''Call Status'' listed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 64 type: string description: Description of the 'Call Type'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CallTrackingCallTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CallTrackingCallType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingCallTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CallTrackingCallType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingCallerType: required: - caller_Type - default_Type type: object properties: caller_Type: maxLength: 32 minLength: 1 type: string description: Name for the 'Caller Type'. default_Type: type: boolean description: 'Sets the associated ''Caller Type'' as the default. New calls will automatically have this ''Caller Type'' listed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 64 type: string description: Description of the 'Caller Type'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CallTrackingCallerTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CallTrackingCallerType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingCallerTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CallTrackingCallerType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingDiagCodes: required: - call_Key - callTrackingDiagCodes_Key - diagnostic_Code - diagnostic_Code_Type - effective_Date type: object properties: callTrackingDiagCodes_Key: type: integer description: 'Unique identifier for each record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 call_Key: type: integer description: 'Unique identifier assigned to the call tracking. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 diagnostic_Code: maxLength: 8 minLength: 1 type: string description: Unique identifier assigned to the diagnosis that will be tied to the call tracking. This can be selected by right-clicking within the field and selecting 'Lookup' from the context menu. diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string description: 'Identifies the ICD version that is associated with the diagnosis code. Note: This field is marked as NOT NULL in the database and therefore required by the API.' effective_Date: type: string description: 'Date when the Diagnostic Code becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CallTrackingDiagCodesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CallTrackingDiagCodes' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingDiagCodesVBAResponse: type: object properties: data: $ref: '#/components/schemas/CallTrackingDiagCodes' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CallTracking' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingProcCodes: required: - call_Key - callTrackingProcCodes_Key type: object properties: callTrackingProcCodes_Key: type: integer description: 'Unique identifier for each record. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 call_Key: type: integer description: 'Unique identifier assigned to the call tracking. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true procedure_Code: maxLength: 8 type: string description: Unique identifier assigned to the procedure that will be tied to the call tracking. This can be selected by right-clicking within the field and selecting 'Lookup' from the context menu. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CallTrackingProcCodesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CallTrackingProcCodes' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingProcCodesVBAResponse: type: object properties: data: $ref: '#/components/schemas/CallTrackingProcCodes' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingSubscriber: required: - call_Key - member_Seq - subscriber_ID type: object properties: call_Key: type: integer description: ID assigned to the call. format: int32 subscriber_ID: maxLength: 9 minLength: 1 type: string description: ID of the Subscriber associated with the call. member_Seq: maxLength: 2 minLength: 1 type: string description: Sequential identifier of the Member associated with the call. additionalProperties: false CallTrackingSubscriberListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CallTrackingSubscriber' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingSubscriberVBAResponse: type: object properties: data: $ref: '#/components/schemas/CallTrackingSubscriber' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallTrackingVBAResponse: type: object properties: data: $ref: '#/components/schemas/CallTracking' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CallbackDTO: type: object properties: verb: type: string description: 'The HTTP Verb (eg: GET, PUT, POST, DELETE)' nullable: true url: type: string description: The fully-qualified URL to call using the Verb nullable: true payload: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' description: The serialized payload to send to the URL using the Verb and Headers nullable: true additionalProperties: false CandidateClaim: type: object properties: batch_Number: type: integer format: int32 batch_Claim: type: integer format: int32 additionalProperties: false Capitation: required: - capitation_Key type: object properties: capitation_Key: type: integer description: 'ID for the capitation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 account_Key: type: integer description: Account number of the Payor. format: int32 nullable: true age: type: integer description: Age of the Member who is associated with the capitation. format: int32 nullable: true capitationPlanRate_Key: type: integer description: ID of the capitation plan rate. format: int32 nullable: true capitationTransaction_Key: type: integer description: ID for the capitation transaction. format: int32 nullable: true capitation_Amount: type: number description: Amount of the capitation adjustment. format: double nullable: true capitation_Date: type: string description: Date when the capitation adjustment takes place. format: date-time nullable: true division_ID: maxLength: 20 type: string description: ID of the Division that is associated with the capitation. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true group_ID: maxLength: 20 type: string description: ID of the Group that is associated with the capitation. nullable: true member_Seq: maxLength: 2 type: string description: Sequential ID of the Member who is associated with the capitation. nullable: true payor_ID: maxLength: 20 type: string description: ID of the Payor who is associated with the capitation. nullable: true plan_ID: maxLength: 20 type: string description: ID of the plan that the capitation is associated with. nullable: true provider_ID: maxLength: 20 type: string description: ID of the Provider who is associated with the capitation. nullable: true subscriber_ID: maxLength: 9 type: string description: ID of the Subscriber who is associated with the capitation. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CapitationAdjustment: required: - capitationAdjustment_Key type: object properties: capitationAdjustment_Key: type: integer description: 'ID of the capitation adjustment. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 account_Key: type: integer description: Account number of the Payor. format: int32 nullable: true adjustment_Amount: type: number description: Amount of the capitation adjustment. format: double nullable: true adjustment_Date: type: string description: Date when the capitation adjustment takes place. format: date-time nullable: true age: type: integer description: Age of the Member who is associated with the capitation. format: int32 nullable: true capitationPlanRate_Key: type: integer description: ID of the capitation plan rate. format: int32 nullable: true capitationTransaction_Key: type: integer description: ID for the capitation transaction. format: int32 nullable: true capitation_Adjustment_Reason: maxLength: 8 type: string description: Reason of the capitation adjustment. 'Capitation Adjustment Reasons' are configured within 'Capitation Configuration'. nullable: true capitation_Adjustment_Type: maxLength: 8 type: string description: Type of the capitation adjustment. 'Capitation Adjustment Types' are configured within 'Capitation Configuration'. nullable: true division_ID: maxLength: 20 type: string description: ID of the Division that is associated with the capitation. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true group_ID: maxLength: 20 type: string description: ID of the Group that is associated with the capitation. nullable: true member_Seq: maxLength: 2 type: string description: Sequential ID of the Member who is associated with the capitation. nullable: true payor_ID: maxLength: 20 type: string description: ID of the Payor who is associated with the capitation. nullable: true plan_ID: maxLength: 20 type: string description: ID of the plan that the capitation is associated with. nullable: true provider_ID: maxLength: 20 type: string description: ID of the Provider who is associated with the capitation. nullable: true subscriber_ID: maxLength: 9 type: string description: ID of the Subscriber who is associated with the capitation. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CapitationAdjustmentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CapitationAdjustment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationAdjustmentReason: required: - capitation_Adjustment_Reason type: object properties: capitation_Adjustment_Reason: maxLength: 8 minLength: 1 type: string description: Name for the 'Capitation Adjustment Reason'. description: maxLength: 64 type: string description: Description of the 'Capitation Adjustment Reason'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CapitationAdjustmentReasonListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CapitationAdjustmentReason' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationAdjustmentReasonVBAResponse: type: object properties: data: $ref: '#/components/schemas/CapitationAdjustmentReason' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationAdjustmentType: required: - capitation_Adjustment_Type type: object properties: capitation_Adjustment_Type: maxLength: 8 minLength: 1 type: string description: Name for the 'Capitation Adjustment Type'. description: maxLength: 64 type: string description: Description of the 'Capitation Adjustment Type'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CapitationAdjustmentTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CapitationAdjustmentType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationAdjustmentTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CapitationAdjustmentType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationAdjustmentVBAResponse: type: object properties: data: $ref: '#/components/schemas/CapitationAdjustment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationCategory: required: - capitation_Category type: object properties: capitation_Category: maxLength: 8 minLength: 1 type: string description: Name for the 'Capitation Category'. description: maxLength: 64 type: string description: Description of the 'Capitation Category'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CapitationCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CapitationCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationCategoryType: required: - capitation_Category - capitation_Type type: object properties: capitation_Category: maxLength: 8 minLength: 1 type: string description: Name for the 'Capitation Category'. capitation_Type: maxLength: 8 minLength: 1 type: string description: Name for the 'Capitation Type'. additionalProperties: false CapitationCategoryTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CapitationCategoryType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationCategoryTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CapitationCategoryType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/CapitationCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationGenerate: type: object properties: payor_ID: type: string nullable: true account_Key: type: integer format: int32 nullable: true group_ID: type: string nullable: true division_ID: type: string nullable: true subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true plan_ID: type: string nullable: true provider_ID: type: string nullable: true capitation_Date: type: string format: date-time nullable: true capitation_Category: type: string nullable: true payee_ID: type: string nullable: true capitationKeys: type: array items: type: integer format: int32 nullable: true additionalProperties: false CapitationListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Capitation' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationPlanRate: required: - adult - capitationPlanRate_Key - child type: object properties: capitationPlanRate_Key: type: integer description: 'ID of the capitation plan rate. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 adult: type: boolean description: 'Indicates that the Member associated with the capitation must be an adult in order for the plan rate to apply to a capitation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' age_From: type: integer description: Beginning age for the required age range for the plan rate to apply to a capitation. format: int32 nullable: true age_Thru: type: integer description: Ending age for the required age range for the plan rate to apply to a capitation. format: int32 nullable: true capitation_Category: maxLength: 8 type: string description: Indicates the category required for the plan rate to apply to a capitation. nullable: true capitation_Type: maxLength: 8 type: string description: Indicates the type required for the plan rate to apply to a capitation. nullable: true child: type: boolean description: 'Indicates that the Member associated with the capitation must be an child in order for the plan rate to apply to a capitation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' effective_Date: type: string description: Date when the plan rate becomes/became effective. format: date-time nullable: true end_Date: type: string description: Date when the plan rate expires/expired. format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true plan_ID: maxLength: 20 type: string description: ID of the plan associated with the plan rate. nullable: true rate: type: number description: Indicates the rate that will be applied by the plan rate. format: double nullable: true sex: maxLength: 1 type: string description: Indicates the sex required for the plan rate to apply to a capitation. nullable: true tier: maxLength: 2 type: string description: Indicates the tier required for the plan rate to apply to a capiation. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CapitationPlanRateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CapitationPlanRate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationPlanRateVBAResponse: type: object properties: data: $ref: '#/components/schemas/CapitationPlanRate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationService: required: - capitationService_Key - diagnostic_Code_Type - require_PCP type: object properties: capitationService_Key: type: integer description: 'ID of the capitation service. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string description: 'Identifies the ICD version associated with the listed diagnostic codes. Note: This field is marked as NOT NULL in the database and therefore required by the API.' effective_Date: type: string description: Date when the capitation service becomes/became effective. format: date-time nullable: true end_Date: type: string description: Date when the capitation service expires/expired. format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true from_Diag_Code: maxLength: 8 type: string description: Starting code for the range of acceptable diagnostic codes for the capitation service. nullable: true from_Procedure: maxLength: 8 type: string description: Starting code for the range of acceptable procedure codes for the capitation service. nullable: true network_ID: maxLength: 10 type: string description: ID of the network associated with the capitation service. nullable: true place_Of_Service: maxLength: 5 type: string description: Place of service associated with the capitation service. nullable: true require_PCP: type: boolean description: 'When this flag is set, the list of TINS must match the PCP for this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' specialty_Code: maxLength: 10 type: string description: Specialty code of the Provider associated with the capitation service. nullable: true thru_Diag_Code: maxLength: 8 type: string description: Ending code for the range of acceptable diagnostic codes for the capitation service. nullable: true thru_Procedure: maxLength: 8 type: string description: Ending code for the range of acceptable procedure codes for the network. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CapitationServiceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CapitationService' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationServicePlan: required: - capitationService_Key - plan_ID type: object properties: capitationService_Key: type: integer description: 'ID for the capitation service. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 plan_ID: maxLength: 20 minLength: 1 type: string description: ID of the plan associated with the capitation service. entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CapitationServicePlanListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CapitationServicePlan' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationServicePlanVBAResponse: type: object properties: data: $ref: '#/components/schemas/CapitationServicePlan' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationServiceTIN: required: - capitationService_Key - federal_ID type: object properties: capitationService_Key: type: integer description: 'ID for the capitation service. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 federal_ID: maxLength: 20 minLength: 1 type: string description: Federal tax ID associated with the capitation service. entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CapitationServiceTINListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CapitationServiceTIN' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationServiceTINVBAResponse: type: object properties: data: $ref: '#/components/schemas/CapitationServiceTIN' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationServiceVBAResponse: type: object properties: data: $ref: '#/components/schemas/CapitationService' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationTransaction: required: - capitationTransaction_Key type: object properties: capitationTransaction_Key: type: integer description: 'ID for the capitation transaction. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 check_Batch: type: integer description: Identifies the batch to which the transaction's check belongs. format: int32 nullable: true description: maxLength: 64 type: string description: Description of the capitation transaction. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true payee_ID: maxLength: 20 type: string description: ID of the Payee associated with the capitation transaction. nullable: true transaction_Date: type: string description: Date when the capitation transaction occurred. format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CapitationTransactionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CapitationTransaction' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationTransactionVBAResponse: type: object properties: data: $ref: '#/components/schemas/CapitationTransaction' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationType: required: - capitation_Type type: object properties: capitation_Type: maxLength: 8 minLength: 1 type: string description: Name of the 'Capitation Type'. description: maxLength: 64 type: string description: Description of the 'Capitation Type'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CapitationTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CapitationType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CapitationType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CapitationVBAResponse: type: object properties: data: $ref: '#/components/schemas/Capitation' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCase: required: - carePlan_Key - case_Key - do_Not_Contact type: object properties: case_Key: type: integer description: Identifier of the case. format: int32 appointment_Date: type: string description: 'User Managed field: Date of next Appointment' format: date-time nullable: true assessment_Date: type: string description: 'User managed field: Date when the case was assessed.' format: date-time nullable: true carePlan_Key: type: integer description: Identifies the type care associated with the case. format: int32 case_Assign_Type: maxLength: 16 type: string description: Who or what Entity the Case was assigned to. nullable: true case_End_Date: type: string description: Day when the case ended. format: date-time nullable: true case_ID: maxLength: 64 type: string description: Identifier of the case. nullable: true case_Priority: type: integer description: Identifies the priority of the case. 'Case Priorities' are configured within 'Care Management Configuration'. format: int32 nullable: true case_Reason: maxLength: 32 type: string description: Identifies the reason of the case. 'Case Reasons' are configured within 'Care Management Configuration'. nullable: true case_Score: type: number description: User Managed field used when Auto Assigning cases. format: double nullable: true case_Start_Date: type: string description: Day when the case began. format: date-time nullable: true case_Status: maxLength: 8 type: string description: Identifies the status of the case. 'Case Statuses' are configured within 'Care Management Configuration'. nullable: true division_ID: maxLength: 20 type: string description: ID of the Division associated with the case. nullable: true do_Not_Contact: type: boolean description: User Managed field for whether or not to contact member. eligibility_Verified: type: string description: 'User Managed field: Date elegibility verified' format: date-time nullable: true eligibility_Verified_Comment: maxLength: 512 type: string description: 'User Managed field: Comment about Eligibility verification.' nullable: true case_Close_Reason: maxLength: 32 type: string description: The identifier of the case close reason. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true group_ID: maxLength: 20 type: string description: ID of the Group associated with the case. nullable: true member_Seq: maxLength: 2 type: string description: Sequential identifier of the Member associated with the case. nullable: true provider_ID: maxLength: 20 type: string description: ID of the Provider associated with the case. nullable: true subscriber_ID: maxLength: 9 type: string description: ID of the Subscriber associated with the case. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CareCaseAction: required: - careCaseAction_Key - case_Key type: object properties: careCaseAction_Key: type: integer format: int32 action_Definition: maxLength: 512 type: string nullable: true action_Status: maxLength: 32 type: string nullable: true action_Type: maxLength: 32 type: string nullable: true caseDetail_Key: type: integer format: int32 nullable: true case_Key: type: integer format: int32 eMail_Body: maxLength: 4000 type: string nullable: true eMail_Recipient: maxLength: 512 type: string nullable: true eMail_Subject: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true event_ID: type: integer format: int32 nullable: true reportQueue_Key: type: integer format: int32 nullable: true reportSeries_Key: type: integer format: int32 nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseActionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseAction' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseActionVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseAction' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseAuth: required: - careCaseAuth_Key type: object properties: careCaseAuth_Key: type: integer format: int32 approved: type: string nullable: true authorization_Number: maxLength: 50 type: string nullable: true careSite_ID: type: integer format: int32 nullable: true case_Key: type: integer format: int32 nullable: true comment: type: string nullable: true disclaimer_Given: type: boolean nullable: true end_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true medical_Concordance_Level: maxLength: 32 type: string nullable: true notConcordant: type: string nullable: true notification: type: string nullable: true provider_Info: maxLength: 256 type: string nullable: true referred_By: maxLength: 256 type: string nullable: true requested: type: string nullable: true start_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseAuthListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseAuth' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseAuthVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseAuth' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalFact: required: - careCaseClinicalFact_Key type: object properties: careCaseClinicalFact_Key: type: integer description: Identifier for the CareCaseClinicalFact format: int32 careCaseClinicalFactCategory: maxLength: 256 type: string description: User Managed field that ties to the Clinical Fact in the system nullable: true careCaseClinicalFactCategoryType: maxLength: 256 type: string description: User Managed field that ties to the Clinical Fact Type in the system nullable: true case_Key: type: integer description: Identifier of the case. format: int32 nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CareCaseClinicalFactCategory: required: - careCaseClinicalFactCategory1 type: object properties: careCaseClinicalFactCategory1: maxLength: 256 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseClinicalFactCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseClinicalFactCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalFactCategoryType: required: - careCaseClinicalFactCategoryType1 type: object properties: careCaseClinicalFactCategoryType1: maxLength: 256 minLength: 1 type: string description: Identifier for the Clinical Fact Category Type careCaseClinicalFactCategory: maxLength: 256 type: string description: Identifier for the Clinical Fact Category nullable: true description: maxLength: 256 type: string description: Description of the Clinical Fact Category Type nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CareCaseClinicalFactCategoryTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseClinicalFactCategoryType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalFactCategoryTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseClinicalFactCategoryType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalFactCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseClinicalFactCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalFactListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseClinicalFact' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalFactVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseClinicalFact' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalTrial: required: - careCaseClinicalTrial_Key type: object properties: careCaseClinicalTrial_Key: type: integer description: 'Identifier for the Clinical Trial Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 careCaseClinicalTrialArm_ID: maxLength: 64 type: string description: User Managed field that ties to the Clinical Trial Arm in the system nullable: true careCaseClinicalTrialReason_ID: maxLength: 64 type: string description: User Managed field that ties to the Clinical Trial Reason in the system. nullable: true careCaseClinicalTrialStudyPhase_ID: maxLength: 64 type: string description: User Managed field that ties to the Study Phase in the system nullable: true case_Key: type: integer description: Identifier of the case. format: int32 nullable: true comment: type: string description: User Managed field that displays the Comment of this Clinical Trial nullable: true disease: type: string description: User Managed field that displays the Disease of this Clinical Trial nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true inclusionExclusion: type: string description: User Managed field that displays the Inclusion Exclusion of this Clinical Trial nullable: true location: type: string description: User Managed field that displays the Location of this Clinical Trial nullable: true protocol_Number: type: string description: User Managed field that displays the Protocol Number of this Clinical Trial nullable: true study_Drug: type: string description: User Managed field that displays the Study Drug of this Clinical Trial nullable: true study_Length: type: string description: User Managed field that displays the Study Length of this Clinical Trial nullable: true study_Title: type: string description: User Managed field that displays the Study Title of this Clinical Trial nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true website: type: string description: User Managed field that displays the Website of this Clinical Trial nullable: true additionalProperties: false CareCaseClinicalTrialArm: required: - careCaseClinicalTrialArm_ID type: object properties: careCaseClinicalTrialArm_ID: maxLength: 64 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseClinicalTrialArmListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrialArm' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalTrialArmVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseClinicalTrialArm' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalTrialListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrial' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalTrialReason: required: - careCaseClinicalTrialReason_ID type: object properties: careCaseClinicalTrialReason_ID: maxLength: 64 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseClinicalTrialReasonListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrialReason' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalTrialReasonVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseClinicalTrialReason' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalTrialStudyPhase: required: - careCaseClinicalTrialStudyPhase_ID type: object properties: careCaseClinicalTrialStudyPhase_ID: maxLength: 64 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseClinicalTrialStudyPhaseListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhase' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalTrialStudyPhaseVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseClinicalTrialStudyPhase' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseClinicalTrialVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseClinicalTrial' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseCompliance: required: - careCaseCompliance_Key - case_Key type: object properties: careCaseCompliance_Key: type: integer format: int32 careCaseCompliance_User: maxLength: 20 type: string nullable: true careCaseEligibilityStatus_ID: maxLength: 256 type: string nullable: true case_Key: type: integer format: int32 comment: maxLength: 4000 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true start_Date: type: string format: date-time nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseComplianceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseCompliance' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseComplianceVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseCompliance' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseConcordance: required: - careCaseConcordance_Key type: object properties: careCaseConcordance_Key: type: integer format: int32 description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseConcordanceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseConcordance' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseConcordanceVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseConcordance' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseDetail: required: - case_Key - caseDetail_Key - caseDetail_Parent - caseDetail_Seq - result_Selected type: object properties: case_Key: type: integer format: int32 caseDetail_Key: type: integer format: int32 carePlan_Category: maxLength: 32 type: string nullable: true caseDetail_Parent: type: integer format: int32 caseDetail_Seq: type: integer format: int32 email_Body: type: string nullable: true email_Recipient: maxLength: 512 type: string nullable: true email_Subject: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true event_Subject: maxLength: 256 type: string nullable: true item_Definition: maxLength: 512 type: string nullable: true item_Metadata: maxLength: 1024 type: string nullable: true item_Result_Type: maxLength: 32 type: string nullable: true item_Score: type: number format: double nullable: true item_Type: maxLength: 32 type: string nullable: true reportDefinition_Key: type: integer format: int32 nullable: true reportSeries_Key: type: integer format: int32 nullable: true result_Date: type: string format: date-time nullable: true result_Decimal: type: number format: double nullable: true result_Number: type: integer format: int32 nullable: true result_Score: type: number format: double nullable: true result_Selected: type: boolean result_String: maxLength: 4000 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseDiagnosis: required: - careCaseDiagnosis_Key - case_Key type: object properties: careCaseDiagnosis_Key: type: integer format: int32 case_Key: type: integer format: int32 comment: type: string nullable: true diag_Stage: type: integer format: int32 nullable: true diagnostic_Code: maxLength: 8 type: string nullable: true diagnostic_Group: maxLength: 32 type: string nullable: true effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseDiagnosisListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseDiagnosis' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseDiagnosisVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseDiagnosis' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseEligibilityStatus: required: - careCaseEligibilityStatus_ID type: object properties: careCaseEligibilityStatus_ID: maxLength: 256 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseEligibilityStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseEligibilityStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseEligibilityStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseEligibilityStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseEmeticRisk: required: - careCaseEmeticRisk_Key type: object properties: careCaseEmeticRisk_Key: type: integer format: int32 description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseEmeticRiskListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseEmeticRisk' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseEmeticRiskVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseEmeticRisk' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseIntake: required: - careCaseIntake_Key type: object properties: careCaseIntake_Key: type: integer format: int32 careCaseIntakeSecondaryType_ID: type: string nullable: true careCaseIntakeType_ID: type: string nullable: true case_Key: type: integer format: int32 nullable: true comment: type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true log_Date: type: string format: date-time nullable: true log_User_ID: maxLength: 64 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseIntakeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseIntake' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseIntakeSecondaryType: required: - careCaseIntakeSecondaryType_ID - careCaseIntakeType_ID type: object properties: careCaseIntakeType_ID: maxLength: 64 minLength: 1 type: string careCaseIntakeSecondaryType_ID: maxLength: 64 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseIntakeSecondaryTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseIntakeSecondaryType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseIntakeSecondaryTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseIntakeSecondaryType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseIntakeType: required: - careCaseIntakeType_ID type: object properties: careCaseIntakeType_ID: maxLength: 64 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseIntakeTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseIntakeType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseIntakeTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseIntakeType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseIntakeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseIntake' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseIntent: required: - careCaseIntent_Key type: object properties: careCaseIntent_Key: type: integer format: int32 description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseIntentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseIntent' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseIntentVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseIntent' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCase' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseLogEntryType: required: - careCaseLogEntryType_Key type: object properties: careCaseLogEntryType_Key: type: integer format: int32 description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseLogEntryTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseLogEntryType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseLogEntryTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseLogEntryType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseLot: required: - careCaseLot_Key type: object properties: careCaseLot_Key: type: integer format: int32 description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseLotListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseLot' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseLotVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseLot' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseMedication: required: - careCaseMedication_Key - case_Key type: object properties: careCaseMedication_Key: type: integer format: int32 case_Key: type: integer format: int32 dosage: type: number format: double nullable: true dosage_Unit: maxLength: 32 type: string nullable: true drug_Code: maxLength: 20 type: string nullable: true drug_Information: maxLength: 1024 type: string nullable: true effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true med_Reconciliation_Date: type: string format: date-time nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseMedicationListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseMedication' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseMedicationVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseMedication' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseMember: required: - case_Key - member_Seq - subscriber_ID type: object properties: case_Key: type: integer format: int32 subscriber_ID: maxLength: 9 minLength: 1 type: string member_Seq: maxLength: 2 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseMemberListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseMember' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseMemberVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseMember' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseNeutropenicRisk: required: - careCaseNeutropenicRisk_Key type: object properties: careCaseNeutropenicRisk_Key: type: integer format: int32 description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseNeutropenicRiskListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseNeutropenicRisk' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseNeutropenicRiskVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseNeutropenicRisk' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseProvider: required: - careCaseProvider_Key - case_Key type: object properties: careCaseProvider_Key: type: integer format: int32 case_Key: type: integer format: int32 effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true provider_ID: maxLength: 20 type: string nullable: true provider_Role_ID: maxLength: 20 type: string nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseProviderListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseProvider' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseProviderVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseProvider' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseSavings: required: - careCaseSavings_Key - case_Key type: object properties: careCaseSavings_Key: type: integer format: int32 case_Key: type: integer format: int32 comment: type: string nullable: true effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true parent_WorkLog_Type: maxLength: 32 type: string nullable: true savings_Amount: type: number format: double nullable: true savings_Type: maxLength: 20 type: string nullable: true secondarySavings_Type: maxLength: 20 type: string nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseSavingsListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseSavings' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseSavingsSecondaryType: required: - careCaseSavingsSecondary_Type - savings_Type type: object properties: savings_Type: maxLength: 20 minLength: 1 type: string careCaseSavingsSecondary_Type: maxLength: 20 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseSavingsSecondaryTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseSavingsSecondaryType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseSavingsSecondaryTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseSavingsSecondaryType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseSavingsType: required: - savings_Type type: object properties: savings_Type: maxLength: 20 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseSavingsTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseSavingsType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseSavingsTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseSavingsType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseSavingsVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseSavings' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseStage: required: - careCaseStage_Key type: object properties: careCaseStage_Key: type: integer format: int32 description: maxLength: 20 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseStageListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseStage' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseStageVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseStage' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseTreatment: required: - careCaseTreatment_Key - case_Key type: object properties: careCaseTreatment_Key: type: integer format: int32 careCaseConcordance_Key: type: integer format: int32 nullable: true careCaseEmeticRisk_Key: type: integer format: int32 nullable: true careCaseIntent_Key: type: integer format: int32 nullable: true careCaseLot_Key: type: integer format: int32 nullable: true careCaseNeutropenicRisk_Key: type: integer format: int32 nullable: true case_Key: type: integer format: int32 comments: type: string nullable: true effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true term_Date: type: string format: date-time nullable: true treatment_Type: maxLength: 32 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseTreatmentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseTreatment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseTreatmentType: required: - treatment_Type type: object properties: treatment_Type: maxLength: 32 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseTreatmentTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseTreatmentType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseTreatmentTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseTreatmentType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseTreatmentVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseTreatment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCase' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseWorkLog: required: - careCaseWorkLog_Key - case_Key - workLog_Billable type: object properties: careCaseWorkLog_Key: type: integer format: int32 case_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true member_Impact_Score: type: number format: double nullable: true plan_Impact_Score: type: number format: double nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true workLog_Billable: type: boolean workLog_Comment: maxLength: 2048 type: string nullable: true workLog_Date: type: string format: date-time nullable: true workLog_Hour: type: integer format: int32 nullable: true workLog_Minute: type: integer format: int32 nullable: true workLog_SecondaryType: maxLength: 32 type: string nullable: true workLog_SecondaryType2: maxLength: 32 type: string nullable: true workLog_SecondaryType3: maxLength: 32 type: string nullable: true workLog_SecondaryType4: maxLength: 32 type: string nullable: true workLog_SecondaryType5: maxLength: 32 type: string nullable: true workLog_Type: maxLength: 32 type: string nullable: true workLog_Units: type: integer format: int32 nullable: true workLog_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseWorkLogListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseWorkLog' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseWorkLogSavingsType: required: - default_Dates - savings_Type - workLog_Type type: object properties: workLog_Type: maxLength: 32 minLength: 1 type: string savings_Type: maxLength: 20 minLength: 1 type: string default_Dates: type: boolean default_Savings_Amount: type: number format: double nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseWorkLogSavingsTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseWorkLogSavingsType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseWorkLogSavingsTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseWorkLogSavingsType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseWorkLogType: required: - workLog_Type type: object properties: workLog_Type: maxLength: 32 minLength: 1 type: string careCaseLogEntryType_ID: type: integer format: int32 nullable: true default_Member_Impact_Score: type: number format: double nullable: true default_Plan_Impact_Score: type: number format: double nullable: true description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseWorkLogTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseWorkLogType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseWorkLogTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseWorkLogType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseWorkLogVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseWorkLog' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseWorkSecondaryLogType: required: - workLog_SecondaryType - workLog_Type type: object properties: workLog_Type: maxLength: 32 minLength: 1 type: string workLog_SecondaryType: maxLength: 32 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareCaseWorkSecondaryLogTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareCaseWorkSecondaryLogType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareCaseWorkSecondaryLogTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareCaseWorkSecondaryLogType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareManager: required: - accepting_Cases - careManager_Key - carePlanAllFg - careTypeAllFg type: object properties: careManager_Key: type: integer format: int32 accepting_Cases: type: boolean access_Co_Worker: type: integer format: int32 nullable: true access_I_Report_To: type: integer format: int32 nullable: true access_Report_To_Me: type: integer format: int32 nullable: true access_Same_Care_Unit: type: integer format: int32 nullable: true careManager_Type: maxLength: 32 type: string nullable: true carePlanAllFg: type: boolean careTypeAllFg: type: boolean case_Threshold: type: integer format: int32 nullable: true case_Weight_Threshold: type: number format: double nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true user_ID: maxLength: 20 type: string nullable: true additionalProperties: false CareManagerCarePlan: required: - careManager_Key - carePlan_Key type: object properties: careManager_Key: type: integer format: int32 carePlan_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareManagerCarePlanListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareManagerCarePlan' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareManagerCarePlanVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareManagerCarePlan' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareManagerCareType: required: - care_Type - careManager_Key type: object properties: careManager_Key: type: integer format: int32 care_Type: maxLength: 32 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareManagerCareTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareManagerCareType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareManagerCareTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareManagerCareType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareManagerCase: required: - careManager_Key - careManagerCase_Key - case_Key type: object properties: careManagerCase_Key: type: integer format: int32 careManager_Key: type: integer format: int32 case_Key: type: integer format: int32 effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareManagerCaseListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareManagerCase' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareManagerCaseVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareManagerCase' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareManagerListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareManager' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareManagerMapping: required: - child_CareManager_Key - parent_CareManager_Key type: object properties: parent_CareManager_Key: type: integer format: int32 child_CareManager_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareManagerMappingListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareManagerMapping' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareManagerMappingVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareManagerMapping' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareManagerType: required: - careManager_Type type: object properties: careManager_Type: maxLength: 32 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareManagerTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareManagerType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareManagerTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareManagerType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareManagerVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareManager' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlan: required: - carePlan_Key type: object properties: carePlan_Key: type: integer format: int32 care_Type: maxLength: 32 type: string nullable: true care_Weight: type: number format: double nullable: true description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CarePlanCategory: required: - carePlan_Category type: object properties: carePlan_Category: maxLength: 32 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CarePlanCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CarePlanCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/CarePlanCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanCustomValue: required: - carePlan_Key - carePlanCustomValue_Key - iD_Code - required type: object properties: carePlanCustomValue_Key: type: integer format: int32 carePlan_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true iD_Code: maxLength: 16 minLength: 1 type: string required: type: boolean update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CarePlanCustomValueListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CarePlanCustomValue' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanCustomValueVBAResponse: type: object properties: data: $ref: '#/components/schemas/CarePlanCustomValue' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanDetail: required: - carePlan_Key - carePlanDetail_Key - carePlanDetail_Parent - carePlanDetail_Seq type: object properties: carePlan_Key: type: integer format: int32 carePlanDetail_Key: type: integer format: int32 carePlanDetail_Parent: type: integer format: int32 carePlanDetail_Seq: type: integer format: int32 carePlan_Category: maxLength: 32 type: string nullable: true eMail_Body: type: string nullable: true eMail_Recipient: maxLength: 512 type: string nullable: true eMail_Subject: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true event_Subject: maxLength: 256 type: string nullable: true item_Definition: maxLength: 512 type: string nullable: true item_Result_Type: maxLength: 32 type: string nullable: true item_Score: type: number format: double nullable: true item_Type: maxLength: 32 type: string nullable: true reportDefinition_Key: type: integer format: int32 nullable: true reportSeries_Key: type: integer format: int32 nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CarePlanDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CarePlanDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/CarePlanDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CarePlan' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanRule: required: - carePlan_Key - carePlanRule_Key type: object properties: carePlanRule_Key: type: integer format: int32 carePlan_Key: type: integer format: int32 description: maxLength: 512 type: string nullable: true effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CarePlanRuleCriteria: required: - carePlanRule_Key - carePlanRuleCriteria_Key - question_CarePlanDetail_Key type: object properties: carePlanRuleCriteria_Key: type: integer format: int32 carePlanRule_Key: type: integer format: int32 criteria_CarePlanDetail_Key: type: integer format: int32 nullable: true criteria_From_Date: type: string format: date-time nullable: true criteria_From_Decimal: type: number format: double nullable: true criteria_From_Number: type: integer format: int32 nullable: true criteria_From_String: maxLength: 256 type: string nullable: true criteria_Operator: maxLength: 32 type: string nullable: true criteria_Thru_Date: type: string format: date-time nullable: true criteria_Thru_Decimal: type: number format: double nullable: true criteria_Thru_Number: type: integer format: int32 nullable: true criteria_Thru_String: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true question_CarePlanDetail_Key: type: integer format: int32 update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CarePlanRuleCriteriaListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CarePlanRuleCriteria' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanRuleCriteriaVBAResponse: type: object properties: data: $ref: '#/components/schemas/CarePlanRuleCriteria' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanRuleDetail: required: - carePlanRule_Key - carePlanRuleDetail_Key type: object properties: carePlanRuleDetail_Key: type: integer format: int32 carePlanRule_Key: type: integer format: int32 eMail_Body: maxLength: 4000 type: string nullable: true eMail_Recipient: maxLength: 512 type: string nullable: true eMail_Subject: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true event_Subject: maxLength: 256 type: string nullable: true item_Definition: maxLength: 512 type: string nullable: true item_Result_type: maxLength: 32 type: string nullable: true item_Score: type: number format: double nullable: true item_Type: maxLength: 32 type: string nullable: true reportDefinition_Key: type: integer format: int32 nullable: true reportSeries_Key: type: integer format: int32 nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CarePlanRuleDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CarePlanRuleDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanRuleDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/CarePlanRuleDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanRuleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CarePlanRule' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanRuleVBAResponse: type: object properties: data: $ref: '#/components/schemas/CarePlanRule' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanScore: required: - carePlan_Key - carePlanScore_Key - carePlanScore_Seq type: object properties: carePlanScore_Key: type: integer format: int32 carePlanScore_Seq: type: integer format: int32 carePlan_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true from_Score: type: number format: double nullable: true score_Description: maxLength: 512 type: string nullable: true score_Operator: maxLength: 32 type: string nullable: true thru_Score: type: number format: double nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CarePlanScoreDetail: required: - carePlanScore_Key - carePlanScoreDetail_Key type: object properties: carePlanScoreDetail_Key: type: integer format: int32 carePlanScore_Key: type: integer format: int32 eMail_Body: maxLength: 4000 type: string nullable: true eMail_Recipient: maxLength: 512 type: string nullable: true eMail_Subject: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true event_Subject: maxLength: 256 type: string nullable: true item_Definition: maxLength: 512 type: string nullable: true item_Result_Type: maxLength: 32 type: string nullable: true item_Type: maxLength: 32 type: string nullable: true reportDefinition_Key: type: integer format: int32 nullable: true reportSeries_Key: type: integer format: int32 nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CarePlanScoreDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CarePlanScoreDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanScoreDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/CarePlanScoreDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanScoreListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CarePlanScore' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanScoreVBAResponse: type: object properties: data: $ref: '#/components/schemas/CarePlanScore' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CarePlanVBAResponse: type: object properties: data: $ref: '#/components/schemas/CarePlan' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareType: required: - care_Type type: object properties: care_Type: maxLength: 32 minLength: 1 type: string care_Weight: type: number format: double nullable: true description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareUnit: required: - careUnit_Key type: object properties: careUnit_Key: type: integer format: int32 address: maxLength: 128 type: string nullable: true address2: maxLength: 128 type: string nullable: true city: maxLength: 64 type: string nullable: true country_ID: maxLength: 8 type: string nullable: true county_Code: maxLength: 8 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true fax_Country_Code: maxLength: 8 type: string nullable: true fax_Number: maxLength: 32 type: string nullable: true name: maxLength: 512 type: string nullable: true phone_Country_Code: maxLength: 8 type: string nullable: true phone_Number: maxLength: 32 type: string nullable: true state: maxLength: 2 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true zip_Code: maxLength: 32 type: string nullable: true additionalProperties: false CareUnitCareManager: required: - careManager_Key - careUnit_Key type: object properties: careUnit_Key: type: integer format: int32 careManager_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true factor: type: number format: double nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CareUnitCareManagerListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareUnitCareManager' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareUnitCareManagerVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareUnitCareManager' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareUnitListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CareUnit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CareUnitVBAResponse: type: object properties: data: $ref: '#/components/schemas/CareUnit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseAttachment: required: - case_Key - caseAttachment_Key type: object properties: caseAttachment_Key: type: integer description: 'Identifier for the Case Attachment Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 attachment: type: string description: Where the Attachment is stored within the database format: byte nullable: true attachment_File: maxLength: 255 type: string description: the File Name for the Case Attachment nullable: true attachment_Path: maxLength: 500 type: string description: The Path for the Case Attachment nullable: true caseAttachment_Type: maxLength: 256 type: string description: What type of Attachment this is nullable: true case_Key: type: integer description: 'Identifier of the case. This is the Case that has the attachment Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 comment: maxLength: 2048 type: string description: User Managed field that displays the Comment for this Attachment nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CaseAttachmentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CaseAttachment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseAttachmentType: required: - caseAttachment_Type - caseAttachmentType_Key type: object properties: caseAttachmentType_Key: type: integer format: int32 caseAttachment_Type: maxLength: 256 minLength: 1 type: string description: maxLength: 2048 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CaseAttachmentTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CaseAttachmentType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseAttachmentTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CaseAttachmentType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseAttachmentVBAResponse: type: object properties: data: $ref: '#/components/schemas/CaseAttachment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseCloseReason: required: - case_Close_Reason type: object properties: case_Close_Reason: maxLength: 32 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CaseCloseReasonListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CaseCloseReason' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseCloseReasonVBAResponse: type: object properties: data: $ref: '#/components/schemas/CaseCloseReason' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseHead: required: - caseHead_Key type: object properties: caseHead_Key: type: integer format: int32 address: maxLength: 128 type: string nullable: true address2: maxLength: 128 type: string nullable: true careManager_Key: type: integer format: int32 nullable: true caseHead_ID: maxLength: 20 type: string nullable: true caseHead_Type: maxLength: 8 type: string nullable: true city: maxLength: 32 type: string nullable: true country_ID: maxLength: 8 type: string nullable: true county_Code: maxLength: 8 type: string nullable: true email_Address: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true fax_Country_Code: maxLength: 8 type: string nullable: true fax_Number: maxLength: 32 type: string nullable: true first_Name: maxLength: 25 type: string nullable: true last_Name: maxLength: 25 type: string nullable: true org_Name: maxLength: 64 type: string nullable: true phone_Country_Code: maxLength: 8 type: string nullable: true phone_Number: maxLength: 32 type: string nullable: true state: maxLength: 2 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true zip_Code: maxLength: 32 type: string nullable: true additionalProperties: false CaseHeadListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CaseHead' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseHeadType: required: - caseHead_Type type: object properties: caseHead_Type: maxLength: 8 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CaseHeadTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CaseHeadType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseHeadTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CaseHeadType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseHeadVBAResponse: type: object properties: data: $ref: '#/components/schemas/CaseHead' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseMedicalConcordanceLevel: required: - medical_Concordance_Level type: object properties: medical_Concordance_Level: maxLength: 32 minLength: 1 type: string description: maxLength: 1024 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CaseMedicalConcordanceLevelListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CaseMedicalConcordanceLevel' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseMedicalConcordanceLevelVBAResponse: type: object properties: data: $ref: '#/components/schemas/CaseMedicalConcordanceLevel' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CasePriority: required: - case_Priority type: object properties: case_Priority: type: integer format: int32 description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CasePriorityListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CasePriority' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CasePriorityVBAResponse: type: object properties: data: $ref: '#/components/schemas/CasePriority' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseReason: required: - case_Reason type: object properties: case_Reason: maxLength: 32 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CaseReasonListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CaseReason' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseReasonVBAResponse: type: object properties: data: $ref: '#/components/schemas/CaseReason' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseStatus: required: - case_Status type: object properties: case_Status: maxLength: 8 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CaseStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CaseStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseStatusReason: required: - case_Status_Reason type: object properties: case_Status_Reason: maxLength: 8 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CaseStatusReasonListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CaseStatusReason' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseStatusReasonVBAResponse: type: object properties: data: $ref: '#/components/schemas/CaseStatusReason' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CaseStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/CaseStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ChangeSubscriberIDRequest: required: - current_Subscriber_ID - new_Subscriber_ID - user_ID type: object properties: user_ID: maxLength: 20 minLength: 1 type: string description: The user for which this request is executed on behalf of. current_Subscriber_ID: maxLength: 9 minLength: 1 type: string description: The current Subscriber_ID that will be changed. new_Subscriber_ID: maxLength: 9 minLength: 1 type: string description: The new Subscriber_ID additionalProperties: false ChatMessage: type: object properties: message: type: string description: The message from the user. nullable: true additionalProperties: false CheckBatch: required: - check_Batch - check_Batch_Date - check_Batch_Exported type: object properties: check_Batch: type: integer description: 'ID of the check batch. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 check_Batch_Date: type: string description: Date when the check batch was created. format: date-time check_Batch_Exported: type: boolean description: 'Indicates that the check batch has been exported. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' check_Batch_Exported_Date: type: string description: Date when the check batch was exported. format: date-time nullable: true description: maxLength: 64 type: string description: Description of the check batch. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CheckBatchListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CheckBatch' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CheckBatchVBAResponse: type: object properties: data: $ref: '#/components/schemas/CheckBatch' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CheckEdit: required: - checkEdit_Key type: object properties: checkEdit_Key: type: integer description: ID of the check edit. format: int32 checkEdit_Object: maxLength: 64 type: string description: PB object used by the check edit to process. nullable: true description: maxLength: 512 type: string description: Description of the check edit. nullable: true display: maxLength: 64 type: string description: Name for the check edit. nullable: true result_Object: maxLength: 64 type: string description: PB object used by the check edit to display results. nullable: true additionalProperties: false CheckEditListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CheckEdit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CheckEditResult: required: - unique_Key type: object properties: unique_Key: type: integer description: Sequenced Unique Key for the Edit being performent. format: int32 checkEdit_Object: maxLength: 64 type: string description: Object used by the check edit to process. nullable: true description: maxLength: 512 type: string description: Description of the check edit. nullable: true display: maxLength: 64 type: string description: Name for the check edit. nullable: true result: type: integer description: 'The result of the Check Edit being performed. 0 is Success. If -1 then error has occurred, look at Result_Message. If > 0, then edit has found a problem that needs user review.' format: int32 nullable: true result_Message: maxLength: 1024 type: string description: 'If there is an error in Result (-1), then this will hold the Result error message.' nullable: true additionalProperties: false CheckEditResultListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CheckEditResult' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CheckEditSetDetail: required: - checkEdit_Key - checkEdit_Sequence - checkEditSetHeader_Key - enabled type: object properties: checkEditSetHeader_Key: type: integer description: 'Identifies which set the check edit belongs to. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 checkEdit_Key: type: integer description: 'Description of the check edit. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 checkEdit_Sequence: type: integer description: 'Indicates a sequence number for the check edit. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 enabled: type: boolean description: 'Indicates that the check edit is currently enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CheckEditSetDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CheckEditSetDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CheckEditSetDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/CheckEditSetDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CheckEditSetHeader: required: - checkEditSetHeader_Key type: object properties: checkEditSetHeader_Key: type: integer description: ID of the check edit set header. format: int32 description: maxLength: 128 type: string description: Description of the check edit set header. nullable: true display: maxLength: 64 type: string description: Name for the check edit set header. nullable: true additionalProperties: false CheckEditSetHeaderListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CheckEditSetHeader' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CheckEditSetHeaderVBAResponse: type: object properties: data: $ref: '#/components/schemas/CheckEditSetHeader' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CheckEditVBAResponse: type: object properties: data: $ref: '#/components/schemas/CheckEdit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CheckStatus: required: - check_Status type: object properties: check_Status: maxLength: 1 minLength: 1 type: string description: Name for the check status. description: maxLength: 64 type: string description: Description of the check status. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CheckStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CheckStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CheckStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/CheckStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CheckType: required: - check_Type type: object properties: check_Type: maxLength: 3 minLength: 1 type: string description: Name for the check type. description: maxLength: 64 type: string description: Description of the check status. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CheckTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CheckType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CheckTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CheckType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Checks: required: - check_ID - generated_835 type: object properties: check_ID: type: integer description: 'ID of the check. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 acH_Number: maxLength: 32 type: string description: ACH (Automated Clearing House) number of the check. nullable: true account_Key: type: integer description: The account key associated with the check. format: int32 nullable: true address2_On_Check: maxLength: 128 type: string description: The second address line on the check. nullable: true address_On_Check: maxLength: 255 type: string description: Address line 1 listed on the check. nullable: true adjustment: type: number description: An adjustment amount assigned to the check. format: double nullable: true admin_Amt: type: number description: Indicates any administrative fee associated with the check. format: double nullable: true amount_Due: type: number description: Amount that was written on the check. format: double nullable: true check_Batch: type: integer description: Identifies which batch the check belongs to. format: int32 nullable: true check_Date: type: string description: Date that was written on the check. format: date-time nullable: true check_Number: maxLength: 20 type: string description: Number of the check. nullable: true check_Paid_Date: type: string description: The date the check was paid. format: date-time nullable: true check_Status: maxLength: 1 type: string description: Indicates the status of the check. nullable: true check_Type: maxLength: 3 type: string description: Indicates the type associated with the check. nullable: true city_On_Check: maxLength: 30 type: string description: City of the check's address. nullable: true cleared_Amount: type: number description: The amount that was cleared. format: double nullable: true cleared_Date: type: string description: The date the check cleared. format: date-time nullable: true country_ID_On_Check: maxLength: 8 type: string description: The country ID on the check. nullable: true create_Date: type: string description: The date the check was created. format: date-time nullable: true create_User: maxLength: 20 type: string description: The user that created the check. nullable: true date_Printed: type: string description: Date when the check was printed. format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true generated_835: type: boolean description: 'Flag that determines if an 835 was generated. Note: This field is marked as NOT NULL in the database and therefore required by the API.' interest: type: number description: The interest amount of the check. format: double nullable: true memo: maxLength: 64 type: string description: Memo line of the check. nullable: true name_On_Address: maxLength: 50 type: string description: The name associated with the address on the check. nullable: true name_On_Check: maxLength: 50 type: string description: Name that was written on the check. nullable: true paid_Amount: type: number description: The amount paid of the check. format: double nullable: true pay_To_Account_Key: type: integer description: The account the check was paid to. format: int32 nullable: true pay_To_ID: maxLength: 20 type: string description: 'Pay_To_ID is the ID based on the Send_Check_To. ''P'' = Payee_ID, ''V'' = Provider_ID, ''S''= Subscriber_ID, ''G'' = Group_ID, ''B'' = Beneficiary_ID' nullable: true payee_ID: maxLength: 20 type: string description: ID of the Payee associated with the check. nullable: true payment_Method: maxLength: 3 type: string description: Identifies the check as a check or wire transfer. nullable: true payor_ID: maxLength: 20 type: string description: ID of the Payor associated with the check. nullable: true reconcile_Key: type: integer description: The reconcile key associated with the check. format: int32 nullable: true send_Check_To: maxLength: 1 type: string description: A code identifying who the check is sent to. nullable: true signature_Key: type: integer description: The signature key associated with the check. format: int32 nullable: true state_On_Check: maxLength: 2 type: string description: State of the check's address. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true wire_Transfer_Date: type: string description: The date of the wire transfer. format: date-time nullable: true zip_On_Check: maxLength: 32 type: string description: Zip code of the check's address. nullable: true additionalProperties: false ChecksDetail: required: - check_ID - item_Seq type: object properties: check_ID: type: integer description: 'ID of the check. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 item_Seq: type: integer description: 'Sequential identifier of the check item. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 adjustment: type: number description: Adjustment amount for the check line. format: double nullable: true admin_Amt: type: number description: Admin fee associated with the check line. format: double nullable: true amount_Due: type: number description: Total amount due for the check. format: double nullable: true claim_Number: type: integer description: Number of the claim associated with the check line. format: int32 nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true interest: type: number description: Interest amount associated with the check line. format: double nullable: true item_Date: type: string description: Date when the check line item was received. format: date-time nullable: true item_Description: maxLength: 45 type: string description: Description of the item associated with the check line. nullable: true item_Type: maxLength: 3 type: string description: Identifies the type of item associated with the check line. nullable: true message: maxLength: 50 type: string description: The message on the check. nullable: true processed: maxLength: 1 type: string description: Indicates tha the check has been processed. nullable: true provider_ID: maxLength: 20 type: string description: ID of the Provider associated with the check line. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ChecksDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ChecksDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ChecksDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ChecksDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ChecksListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Checks' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ChecksVBAResponse: type: object properties: data: $ref: '#/components/schemas/Checks' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Claim: required: - abF_Exported - adjustment_Claim - advance_Pay - advice_To_Pay - aeoB_Claim - auto_Flex - calculate_Interest - capitation_Claim - ceridian_Exported - claim_Exported - claim_Number - diagnostic_Code_Type - liability_Injury - occupational - orthodontics_Treatment - other_Insurance - override_Network_ID - override_Payor_Account - partial_Disability - patient_Signature - prosthesis_Replacement - refund_Claim - related_To_Accident - related_To_Another_Party - related_To_Auto - related_To_Employment - salary_Continuation - sick_Time - subscriber_Signature - survivor_Benefit - third_Party_Payment - total_COB - transaction_837 - vacation - void_Claim - volume_Override - waiting_Period_Claim type: object properties: claim_Number: type: integer description: 'Unique identifier assigned each time a claim is processed from batch. This value can change if a claim is returned to batch and reprocessed. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 abF_Exported: type: boolean description: 'Used by VBA Backroom IT Services to track export status of a claim using ABF. This has since been moved to ClaimExport tables and is no longer in use. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' abF_Exported_Date: type: string description: Used by VBA Backroom IT Services to track export status of a claim using ABF. This has since been moved to ClaimExport tables and is no longer in use. format: date-time nullable: true aeoB_Claim: type: boolean description: 'A flag indicating a claim is an Advanced EOB and not a claim for payment. Part of the No Surprise Act. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' accident_Date: type: string description: The date of accident. format: date-time nullable: true account_Key: type: integer description: 'For claim funding, indicates the payor/account this claim would be paid from.' format: int32 nullable: true adjustment_Claim: type: boolean description: 'Indicates that this claim was part of an Adjustment process. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' admin_Amt: type: number description: No longer in use. format: double nullable: true admission_Date: type: string description: 'For institutional Claims, holds the Admission Date.' format: date-time nullable: true admission_Diagnostic_Code: maxLength: 8 type: string description: The admission diagnosis code if applicable for this claim. nullable: true admission_Hour: maxLength: 8 type: string description: 'For institutional Claims, holds the Admission Hour.' nullable: true admission_Source: maxLength: 8 type: string description: 'For institutional Claims, holds the Admission Source.' nullable: true admit_Date: type: string description: Used to identify the date the member was admitted to the Hospital if hospitalized as part of this disability. format: date-time nullable: true advance_Pay: type: boolean description: 'Indicates if this claim, for disability, can be processed and paid in advance of that service dates. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' advice_To_Pay: type: boolean description: 'Notes this claim is advice to pay and will not go through funding. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' all_Docs_Rec_Date: type: string description: Information field used in custom processing and reporting. format: date-time nullable: true ambulance_DropOff_Address: maxLength: 90 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_DropOff_Address2: maxLength: 90 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_DropOff_City: maxLength: 32 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_DropOff_Location: maxLength: 64 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_DropOff_Org_Name: maxLength: 512 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_DropOff_State: maxLength: 10 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_DropOff_Zip: maxLength: 32 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_PickUp_Address: maxLength: 90 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_PickUp_Address2: maxLength: 90 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_PickUp_City: maxLength: 32 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_PickUp_Location: maxLength: 64 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_PickUp_State: maxLength: 10 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_PickUp_Zip: maxLength: 32 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true appliance_Placed_Date: type: string description: The date the orthodontic appliance was placed. format: date-time nullable: true assumed_Care_Date: type: string description: Information field used in custom processing and reporting. format: date-time nullable: true attended_Physician_Date: type: string description: 'This identifies the date the member first visited the Physician. This field, in combination with Disabled by Physician Date and Last Day Worked, create the Disability Date for the Member.' format: date-time nullable: true auto_Flex: type: boolean description: 'Notes if this Flex claim was auto-generated by the adjducation engine based on member responsibility configuration at the Group. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' batch_Claim: type: integer description: 'This value, in combination with Batch_Number, creates a unique identifier for each claim that is maintained in both batch and processed.' format: int32 nullable: true batch_Number: type: integer description: 'This value, in combination with Batch_Claim, creates a unique identifier for each claim that is maintained in both batch and processed.' format: int32 nullable: true beneficiary_ID: maxLength: 20 type: string description: Notes the beneficiary for Life & Disability claims. References the MemberBeneficiary.Beneficiary_ID. nullable: true cliA_Number: maxLength: 32 type: string description: No longer in use. nullable: true calculate_Interest: type: boolean description: 'Notes if interest was calculated for this claim as part of adjudication. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' capitation_Claim: type: boolean description: 'Indicates if this claim is capitated. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' ceridian_Exported: type: boolean description: 'Used in custom integration with ceridian tax services. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' ceridian_Exported_Date: type: string description: Used in custom integration with ceridian tax services. format: date-time nullable: true check_Batch: type: integer description: 'This is the primary indicator if a claim is "Paid". When this value is NULL, the claim has been processed but not paid. When paid, this value will hold what Check Batch the claim was paid under. References CheckBatch.Check_Batch.' format: int32 nullable: true check_ID: type: integer description: Holds the Check ID this claim was paid under. References Checks.Check_ID. format: int32 nullable: true check_Number: maxLength: 20 type: string description: No longer in use. nullable: true claim_837_COB: maxLength: 1 type: string description: 'For 837 transactions, indicates COB has been submitted.' nullable: true claim_Exported: type: boolean description: 'Used by VBA Backroom IT Services to track export status of a claim. This has since been moved to ClaimExport tables and is no longer in use. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' claim_Exported_Date: type: string description: Used by VBA Backroom IT Services to track export status of a claim. This has since been moved to ClaimExport tables and is no longer in use. format: date-time nullable: true claim_Funded_Status: maxLength: 32 type: string description: 'Indicates the Claim Funded Status for this claim, indicating if the claim is ready for funding, suspended, a candidate for payment, part of a funding request or funded.' nullable: true claim_ID: maxLength: 32 type: string description: An identifier assigned by external vendors and used for integrations. Primarily comes from the REF*D9 value in the 837. nullable: true claim_Priority: maxLength: 1 type: string description: 'For 837 transactions, indicates the submitted claim priority.' nullable: true claim_Status: maxLength: 8 type: string description: The status of the claim. Valid values reside in the ClaimStatus table. nullable: true claim_Type: maxLength: 20 type: string description: Notes the claim type for this claim. References ClaimType.Claim_Type. nullable: true closure_Effective_Date: type: string description: This is an information only field that allows the tracking of the Closure Effective Date. format: date-time nullable: true condition_Code1: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code10: maxLength: 8 type: string nullable: true condition_Code11: maxLength: 8 type: string nullable: true condition_Code12: maxLength: 8 type: string nullable: true condition_Code13: maxLength: 8 type: string nullable: true condition_Code14: maxLength: 8 type: string nullable: true condition_Code15: maxLength: 8 type: string nullable: true condition_Code16: maxLength: 8 type: string nullable: true condition_Code17: maxLength: 8 type: string nullable: true condition_Code18: maxLength: 8 type: string nullable: true condition_Code19: maxLength: 8 type: string nullable: true condition_Code2: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code20: maxLength: 8 type: string nullable: true condition_Code21: maxLength: 8 type: string nullable: true condition_Code22: maxLength: 8 type: string nullable: true condition_Code23: maxLength: 8 type: string nullable: true condition_Code24: maxLength: 8 type: string nullable: true condition_Code3: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code4: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code5: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code6: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code7: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code8: maxLength: 8 type: string nullable: true condition_Code9: maxLength: 8 type: string nullable: true coverage_Start: type: string description: 'The patients (or Subscribers) enrollment information, references Subenrollment.Group_Coverage_Start.' format: date-time nullable: true current_Illness_Date: type: string description: The current illness date for this claim. format: date-time nullable: true drG_Code: maxLength: 4 type: string description: 'The DRG Code for this claim, if applicable. References the DRGCodes.DRG_Code.' nullable: true drG_Quantity: type: number description: The quantity associated with this DRG value. format: double nullable: true death_Cert_Rec_Date: type: string description: Information field used in custom processing and reporting. format: date-time nullable: true delivery_Date: type: string description: This identifies the date of delivery for disability due to pregnancy. format: date-time nullable: true delivery_Type: maxLength: 1 type: string description: This will identify the type of delivery that is performed as a result of pregnancy. nullable: true dep_SSDI_End_Date: type: string description: This is an information only field that allows the tracking of Dependent SSI End Date. format: date-time nullable: true diagnostic_Code1: maxLength: 8 type: string description: 'An assigned diagnostic code for this claim. This field, in the absence of a corresponding diagnosis pointer from a claim service line, indicates the primary diagnosis.' nullable: true diagnostic_Code10: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code11: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code12: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code13: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code14: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code15: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code16: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code17: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code18: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code19: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code2: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code20: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code21: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code22: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code23: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code24: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code3: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code4: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code5: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code6: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code7: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code8: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code9: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string description: 'Indicates if the Diagnostic Code values on this claim are ICD9 or ICD10. Two possible values: 9 - ICD9 or 0 - ICD10.' disability_Date: type: string description: The calculated date of disability (or manually enetered) based on the disabilty advisor in VBASoftware. format: date-time nullable: true disability_End_Date: type: string description: Information field used in custom processing and reporting. format: date-time nullable: true disability_Type: maxLength: 20 type: string description: Used to identify the type of disability (Injury or Illness). nullable: true disabled_By_Physician: type: string description: 'This identifies the date the member was disabled by the Physician. This field, in combination with First Attended Physician Date and Last Day Worked, create the Disability Date for the Member.' format: date-time nullable: true discharge_Date: type: string description: Used to identify the date the member was discharged from the Hospital if hospitalized as part of this disability. format: date-time nullable: true discharge_Hour: maxLength: 8 type: string description: 'For institutional Claims, holds the Discharge Hour.' nullable: true division_ID: maxLength: 20 type: string description: 'The patients (or Subscribers) enrollment information, references Subenrollment.Division_ID.' nullable: true eCode_Diagnostic_Code: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code10: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code11: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code12: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code2: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code3: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code4: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code5: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code6: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code7: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code8: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code9: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true epsdT_Condition_Indicator1: maxLength: 3 type: string description: 'Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.' nullable: true epsdT_Condition_Indicator2: maxLength: 3 type: string description: 'Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.' nullable: true epsdT_Condition_Indicator3: maxLength: 3 type: string description: 'Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.' nullable: true epsdT_Referral_Given: maxLength: 1 type: string description: 'Early and Periodic Screening, Diagnostic, and Treatment tracking for if a referral was given for this claim.' nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code1: maxLength: 6 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true ex_Code2: maxLength: 6 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true ex_Code3: maxLength: 8 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true ex_Code4: maxLength: 8 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true exhaust_Date: type: string description: This is the Exhaust Date of the members Disability. format: date-time nullable: true expected_Typical_Duration: type: integer description: Expected Typical Duration (ETD) is the duration of disability identified by the MDA based on the type of job the member has as well as the diagnosis of the disability. format: int32 nullable: true ficA_Percent: type: number description: 'This will hold the FICA withhold amount for each payment. If tax calculation module is enabled, this option will be ignored.' format: double nullable: true federal_Withheld: type: number description: 'This will hold the federal withhold amount for each payment. If tax calculation module is enabled, this option will be ignored.' format: double nullable: true filing_Indicator: maxLength: 2 type: string description: No longer in use. nullable: true followUp_Date: type: string description: This will place a follow-up date on each payment as an additional identifier for when this disability should be reviewed. format: date-time nullable: true followUp_Ex_Code: maxLength: 6 type: string description: This will place a follow-up ex code on each payment to allow the user to categorize what type of follow-up is being performed. nullable: true freq_Code: maxLength: 8 type: string description: Medicare Resubmission code for the claim. Indicated in Box 22 of the claim report. nullable: true group_ID: maxLength: 20 type: string description: 'The patients (or Subscribers) enrollment information, references Subenrollment.Group_ID.' nullable: true hearing_Vision_RX_Date: type: string description: Information field used in custom processing and reporting. format: date-time nullable: true image_File_Location: maxLength: 128 type: string description: 'Stores a reference, if applicable, to an image or document associated with this claim.' nullable: true image_File_Location2: maxLength: 128 type: string description: 'Stores a reference, if applicable, to an image or document associated with this claim.' nullable: true image_File_Location3: maxLength: 128 type: string description: 'Stores a reference, if applicable, to an image or document associated with this claim.' nullable: true image_File_Location4: maxLength: 128 type: string description: 'Stores a reference, if applicable, to an image or document associated with this claim.' nullable: true initial_Treatment_Date: type: string description: Information field to track the initial treatment date for this claim. format: date-time nullable: true job_Type: maxLength: 2 type: string description: This is the job classification for the member going on disability. nullable: true ltD_Effective_Date: type: string description: This is an information only field that holds the date the member went on Long-Term Disability. format: date-time nullable: true ltD_Packet_Date: type: string description: This is an information only field that tracks the date the Long-Term Disability Packet was sent. format: date-time nullable: true last_Day_Worked: type: string description: 'This identifies the date the member last attended work prior to going on disability. This field, in combination with First Attended Physician Date and Disabled by Physician, create the Disability Date for the Member.' format: date-time nullable: true last_Physician_Warrant_Date: type: string description: This is an information only field that allows for the tracking of the Physician Warrant Date. format: date-time nullable: true last_Seen_Date: type: string description: Information field to track the last time a phyician was seen at the time of this claim submission. format: date-time nullable: true liability_Injury: type: boolean description: 'This is an information only field that identifies if this disability is a liability injury. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' mail_To: maxLength: 1 type: string description: Notes if the payment should be mailed to an entity other than the "Send_Check_To". nullable: true member_Seq: maxLength: 2 type: string description: The Member Sequence of the patient for this claim. nullable: true months_Of_Treatment: type: integer description: The number of months the orthodontic treatment will be. format: int32 nullable: true network_ID: maxLength: 10 type: string description: 'Indicates the network this claim was paid against. If this value is NULL, the claim is considered "Out of Network".' nullable: true note: maxLength: 24 type: string description: No longer in use. Replaced by Note Services. nullable: true occupational: type: boolean description: 'Notes if the disability is related to the patiens occupation. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' occurrence_Code1: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code10: maxLength: 8 type: string nullable: true occurrence_Code11: maxLength: 8 type: string nullable: true occurrence_Code12: maxLength: 8 type: string nullable: true occurrence_Code13: maxLength: 8 type: string nullable: true occurrence_Code14: maxLength: 8 type: string nullable: true occurrence_Code15: maxLength: 8 type: string nullable: true occurrence_Code16: maxLength: 8 type: string nullable: true occurrence_Code17: maxLength: 8 type: string nullable: true occurrence_Code18: maxLength: 8 type: string nullable: true occurrence_Code19: maxLength: 8 type: string nullable: true occurrence_Code2: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code20: maxLength: 8 type: string nullable: true occurrence_Code21: maxLength: 8 type: string nullable: true occurrence_Code22: maxLength: 8 type: string nullable: true occurrence_Code23: maxLength: 8 type: string nullable: true occurrence_Code24: maxLength: 8 type: string nullable: true occurrence_Code3: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code4: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code5: maxLength: 8 type: string nullable: true occurrence_Code6: maxLength: 8 type: string nullable: true occurrence_Code7: maxLength: 8 type: string nullable: true occurrence_Code8: maxLength: 8 type: string nullable: true occurrence_Code9: maxLength: 8 type: string nullable: true occurrence_Date1: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date10: type: string format: date-time nullable: true occurrence_Date11: type: string format: date-time nullable: true occurrence_Date12: type: string format: date-time nullable: true occurrence_Date13: type: string format: date-time nullable: true occurrence_Date14: type: string format: date-time nullable: true occurrence_Date15: type: string format: date-time nullable: true occurrence_Date16: type: string format: date-time nullable: true occurrence_Date17: type: string format: date-time nullable: true occurrence_Date18: type: string format: date-time nullable: true occurrence_Date19: type: string format: date-time nullable: true occurrence_Date2: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date20: type: string format: date-time nullable: true occurrence_Date21: type: string format: date-time nullable: true occurrence_Date22: type: string format: date-time nullable: true occurrence_Date23: type: string format: date-time nullable: true occurrence_Date24: type: string format: date-time nullable: true occurrence_Date3: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date4: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date5: type: string format: date-time nullable: true occurrence_Date6: type: string format: date-time nullable: true occurrence_Date7: type: string format: date-time nullable: true occurrence_Date8: type: string format: date-time nullable: true occurrence_Date9: type: string format: date-time nullable: true occurrence_Span_Code: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code10: maxLength: 8 type: string nullable: true occurrence_Span_Code11: maxLength: 8 type: string nullable: true occurrence_Span_Code12: maxLength: 8 type: string nullable: true occurrence_Span_Code13: maxLength: 8 type: string nullable: true occurrence_Span_Code14: maxLength: 8 type: string nullable: true occurrence_Span_Code15: maxLength: 8 type: string nullable: true occurrence_Span_Code16: maxLength: 8 type: string nullable: true occurrence_Span_Code17: maxLength: 8 type: string nullable: true occurrence_Span_Code18: maxLength: 8 type: string nullable: true occurrence_Span_Code19: maxLength: 8 type: string nullable: true occurrence_Span_Code2: maxLength: 8 type: string nullable: true occurrence_Span_Code20: maxLength: 8 type: string nullable: true occurrence_Span_Code21: maxLength: 8 type: string nullable: true occurrence_Span_Code22: maxLength: 8 type: string nullable: true occurrence_Span_Code23: maxLength: 8 type: string nullable: true occurrence_Span_Code24: maxLength: 8 type: string nullable: true occurrence_Span_Code3: maxLength: 8 type: string nullable: true occurrence_Span_Code4: maxLength: 8 type: string nullable: true occurrence_Span_Code5: maxLength: 8 type: string nullable: true occurrence_Span_Code6: maxLength: 8 type: string nullable: true occurrence_Span_Code7: maxLength: 8 type: string nullable: true occurrence_Span_Code8: maxLength: 8 type: string nullable: true occurrence_Span_Code9: maxLength: 8 type: string nullable: true occurrence_Span_From: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From10: type: string format: date-time nullable: true occurrence_Span_From11: type: string format: date-time nullable: true occurrence_Span_From12: type: string format: date-time nullable: true occurrence_Span_From13: type: string format: date-time nullable: true occurrence_Span_From14: type: string format: date-time nullable: true occurrence_Span_From15: type: string format: date-time nullable: true occurrence_Span_From16: type: string format: date-time nullable: true occurrence_Span_From17: type: string format: date-time nullable: true occurrence_Span_From18: type: string format: date-time nullable: true occurrence_Span_From19: type: string format: date-time nullable: true occurrence_Span_From2: type: string format: date-time nullable: true occurrence_Span_From20: type: string format: date-time nullable: true occurrence_Span_From21: type: string format: date-time nullable: true occurrence_Span_From22: type: string format: date-time nullable: true occurrence_Span_From23: type: string format: date-time nullable: true occurrence_Span_From24: type: string format: date-time nullable: true occurrence_Span_From3: type: string format: date-time nullable: true occurrence_Span_From4: type: string format: date-time nullable: true occurrence_Span_From5: type: string format: date-time nullable: true occurrence_Span_From6: type: string format: date-time nullable: true occurrence_Span_From7: type: string format: date-time nullable: true occurrence_Span_From8: type: string format: date-time nullable: true occurrence_Span_From9: type: string format: date-time nullable: true occurrence_Span_Thru: type: string description: The occurrence span thru for this claim. format: date-time nullable: true occurrence_Span_Thru10: type: string format: date-time nullable: true occurrence_Span_Thru11: type: string format: date-time nullable: true occurrence_Span_Thru12: type: string format: date-time nullable: true occurrence_Span_Thru13: type: string format: date-time nullable: true occurrence_Span_Thru14: type: string format: date-time nullable: true occurrence_Span_Thru15: type: string format: date-time nullable: true occurrence_Span_Thru16: type: string format: date-time nullable: true occurrence_Span_Thru17: type: string format: date-time nullable: true occurrence_Span_Thru18: type: string format: date-time nullable: true occurrence_Span_Thru19: type: string format: date-time nullable: true occurrence_Span_Thru2: type: string format: date-time nullable: true occurrence_Span_Thru20: type: string format: date-time nullable: true occurrence_Span_Thru21: type: string format: date-time nullable: true occurrence_Span_Thru22: type: string format: date-time nullable: true occurrence_Span_Thru23: type: string format: date-time nullable: true occurrence_Span_Thru24: type: string format: date-time nullable: true occurrence_Span_Thru3: type: string format: date-time nullable: true occurrence_Span_Thru4: type: string format: date-time nullable: true occurrence_Span_Thru5: type: string format: date-time nullable: true occurrence_Span_Thru6: type: string format: date-time nullable: true occurrence_Span_Thru7: type: string format: date-time nullable: true occurrence_Span_Thru8: type: string format: date-time nullable: true occurrence_Span_Thru9: type: string format: date-time nullable: true onset_Similar_Illness_Date: type: string description: Notes the date of the original illness if this claim is associated to that illness. format: date-time nullable: true orthodontics_Treatment: type: boolean description: 'When this flag is checked, it indicates the dental claim is for orthodontics. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' other_Insurance: type: boolean description: 'Indicates if other insurance is applicable on this claim. This indicator unlocks COB amount fields on the ClaimDetail (service line). Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' other_Procedure_Code1: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code10: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code11: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code12: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code13: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code14: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code15: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code16: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code17: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code18: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code19: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code2: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code20: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code21: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code22: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code23: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code3: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code4: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code5: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code6: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code7: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code8: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code9: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Date1: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date10: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date11: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date12: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date13: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date14: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date15: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date16: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date17: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date18: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date19: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date2: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date20: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date21: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date22: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date23: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date3: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date4: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date5: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date6: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date7: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date8: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date9: type: string description: Date associated with the additional procedure code. format: date-time nullable: true override: maxLength: 1 type: string description: No longer in use. nullable: true override_Date: type: string description: No longer in use. format: date-time nullable: true override_Network_ID: type: boolean description: 'This indicator lets the system know that the front end user has assigned this network ID and not adjudication. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' override_Payor_Account: type: boolean description: 'Users can choose the payor from the More Information screen and this flag prevents adjudication from using the expected payor. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' override_User: maxLength: 16 type: string description: No longer in use. nullable: true partial_Disability: type: boolean description: 'This will identify if this is a partial disability payment. Partial Disability payments have additional tax and payment rules applied during adjudication. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' patient_Account: maxLength: 128 type: string description: 'For the servicing provider, this indicates the patient account identifier in their practice management system.' nullable: true patient_Reason_for_Visit_Diagnostic_Code1: maxLength: 8 type: string description: Reason for Visit code on Diagnosis Code 1 nullable: true patient_Reason_for_Visit_Diagnostic_Code2: maxLength: 8 type: string description: Reason for Visit code on Diagnosis Code 2 nullable: true patient_Reason_for_Visit_Diagnostic_Code3: maxLength: 8 type: string description: Reason for Visit code on Diagnosis Code 3 nullable: true patient_Relationship: maxLength: 8 type: string description: Holds the relationship of the patient to the insured. nullable: true patient_Signature: type: boolean description: 'Indicates if the patient signature has been collected. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' patient_Signature_Date: type: string description: Indicates the date of the patient signature being collected. format: date-time nullable: true patient_Status: maxLength: 8 type: string description: 'For institutional Claims, holds the Patient Status.' nullable: true payee_ID: maxLength: 20 type: string description: The billing provider (payee) for this claim. References the ProviderPayee.Payee_ID (by Provider_ID). nullable: true payment_Status: maxLength: 1 type: string description: No longer in use. nullable: true payor_Claim_Control_Number: maxLength: 64 type: string description: A claim reference number used in conjunction with the Medicare Resubmission code. Indicated in Box 22 of the claim report. nullable: true payor_ID: maxLength: 20 type: string description: 'For claim funding, indicates the payor/account this claim would be paid from.' nullable: true physician_Return_To_Work: type: string description: This is the Return to Work date identified by the Physician at the start of disability. This may or may not be the actual date the member returns to work. format: date-time nullable: true place_Of_Service: maxLength: 5 type: string description: Some transactions hold the Place of Service at the header but typically this value is empty and the ClaimDetail.Place_Of_Service is used for each service line. This value is not used in standard processing. nullable: true plan_ID: maxLength: 20 type: string description: Holds the plan the patient is enrolled in and that benefits are assigned. nullable: true plan_Provider: maxLength: 1 type: string description: No longer in use. nullable: true plan_Year: maxLength: 8 type: string description: Indicates the Plan Year this claim is processed under. This drives accumulator calculations and referneces the GroupPlanYear.Plan_Year value. nullable: true present_On_Admission1: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 1. nullable: true present_On_Admission10: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 10. nullable: true present_On_Admission11: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 11. nullable: true present_On_Admission12: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 12. nullable: true present_On_Admission13: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 13. nullable: true present_On_Admission14: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 14. nullable: true present_On_Admission15: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 15. nullable: true present_On_Admission16: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 16. nullable: true present_On_Admission17: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 17. nullable: true present_On_Admission18: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 18. nullable: true present_On_Admission19: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 19. nullable: true present_On_Admission2: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 2. nullable: true present_On_Admission20: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 20. nullable: true present_On_Admission21: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 21. nullable: true present_On_Admission22: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 22. nullable: true present_On_Admission23: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 23. nullable: true present_On_Admission24: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 24. nullable: true present_On_Admission3: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 3. nullable: true present_On_Admission4: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 4. nullable: true present_On_Admission5: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 5. nullable: true present_On_Admission6: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 6. nullable: true present_On_Admission7: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 7. nullable: true present_On_Admission8: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 8. nullable: true present_On_Admission9: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 9. nullable: true present_On_Admission_ECode1: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 1. nullable: true present_On_Admission_ECode10: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 10. nullable: true present_On_Admission_ECode11: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 11. nullable: true present_On_Admission_ECode12: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 12. nullable: true present_On_Admission_ECode2: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 2. nullable: true present_On_Admission_ECode3: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 3. nullable: true present_On_Admission_ECode4: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 4. nullable: true present_On_Admission_ECode5: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 5. nullable: true present_On_Admission_ECode6: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 6. nullable: true present_On_Admission_ECode7: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 7. nullable: true present_On_Admission_ECode8: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 8. nullable: true present_On_Admission_ECode9: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 9. nullable: true pricing_Method: maxLength: 8 type: string description: 'For reprice claims (typically submitted via 837), this notes the reprice method used to reprice this claim.' nullable: true pricing_Org_ID: maxLength: 50 type: string description: The ID of the pricing organization. Data is obtained in segment HCP04 on an 837. nullable: true pricing_Rate: type: number description: The rate associated with the reprice method (Pricing_Method). format: double nullable: true principal_Procedure_Code: maxLength: 8 type: string description: The principal procedure (ICD10 Diagnosis) for this claim submission. nullable: true principal_Procedure_Date: type: string description: The principal procedure date. format: date-time nullable: true prior_Placement_Date: type: string description: 'The date of a previous prosthetic or crown applied, if there was one.' format: date-time nullable: true processed_Date: type: string description: The date the claim was processed from batch. format: date-time nullable: true prosthesis_Replacement: type: boolean description: 'This flag indicates if this claim is for the replacement of a prosthesis. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' provider_ID: maxLength: 20 type: string description: The provider ID of the servicing provider. References Provider.Provider_ID. nullable: true qpA_Method: maxLength: 1 type: string description: Overrides the QPA Method set on the Plan for this claim. nullable: true received_Date: type: string description: The date this claim was received into the admin system. format: date-time nullable: true referred_By: maxLength: 30 type: string description: Information field to track if a referral was sent for this claim. nullable: true refund_Claim: type: boolean description: 'Indicates that this claim was part of a Refund process. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' refund_Funding_Key: type: integer description: 'If this claim was part of a refund process, this will hold the reference to the receipt generated by the refund process.' format: int32 nullable: true related_To_Accident: type: boolean description: 'Indicates if the claim is related to a non-car accident. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' related_To_Another_Party: type: boolean description: 'Indicates if the claim was casued by a third party. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' related_To_Auto: type: boolean description: 'Indicates if the claim is related to a car accident. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' related_To_Employment: type: boolean description: 'Indicates if the claim is work related. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' relinquished_Care_Date: type: string description: Information field used in custom processing and reporting. format: date-time nullable: true remittance_Printed: maxLength: 1 type: string description: No longer in use. nullable: true reprice_Printed: maxLength: 1 type: string description: No longer in use. nullable: true repriced_Network_ID: maxLength: 50 type: string description: 'As part of reprice claim submissions (via 837), this will hold the repricing network.' nullable: true return_To_Work_Date: type: string description: This is the date the member Returned to Work. This date affects the total payments created as well as other calculations during adjudication. format: date-time nullable: true salary_Continuation: type: boolean description: 'This flag identifies that there is salary continuation during this disability. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' send_Check_To: maxLength: 1 type: string description: 'Indicates the entity that should be paid for this claim. S - Subscriber, G - Group, B - Beneficiary, P - Payee, or V - Provider.' nullable: true sender_ID: maxLength: 15 type: string description: The Sender ID sent inbound for x12 (837) transactions. nullable: true service_Date: type: string description: The earliest Service_Date of all service lines on this claim. format: date-time nullable: true service_Thru: type: string description: The latest Service_Thru for all service lines on this claim. format: date-time nullable: true sick_Time: type: boolean description: 'This flag identifies that there is sick time during this disability. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' statement_From_Date: type: string description: 'For Institutional Claims, holds the Statement Date.' format: date-time nullable: true statement_Thru_Date: type: string description: 'For Institutional Claims, holds the Statement Date.' format: date-time nullable: true subscriber_ID: maxLength: 9 type: string description: The Subscriber ID of the patient for this claim. nullable: true subscriber_Signature: type: boolean description: 'Indicates if the insured signature has been collected. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' survivor_Benefit: type: boolean description: 'Indicates if Survivor Benefit was applied for this disability payment. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' third_Party_Payment: type: boolean description: 'For disability, indicates if this professional claim is a 3rd party payment (typically related to alimony, garnishment, etc.) Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' total_COB: type: number description: 'COB total for all claim detail lines Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double trading_Partner_Key: type: integer description: No longer in use. format: int32 nullable: true trans_837_Control_Num: maxLength: 9 type: string description: 'For 837 transactions, this is the control number assgined by the submitter.' nullable: true transaction_837: type: boolean description: 'Indicates this is a claim entered by an inbound 837. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' transaction_837_ID: maxLength: 30 type: string description: 'For 837 transactions, this holds the transaction ID assigned by the submission.' nullable: true type_Of_Admission: maxLength: 6 type: string description: The Admission Type associated to this claim. nullable: true type_Of_Bill: maxLength: 6 type: string description: The Bill Type associated to this claim. References BillType.Type_Of_Bill. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true vacation: type: boolean description: 'This flag identifies that there is vacation during this disability. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' value_Amount1: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount10: type: number format: double nullable: true value_Amount11: type: number format: double nullable: true value_Amount12: type: number format: double nullable: true value_Amount13: type: number format: double nullable: true value_Amount14: type: number format: double nullable: true value_Amount15: type: number format: double nullable: true value_Amount16: type: number format: double nullable: true value_Amount17: type: number format: double nullable: true value_Amount18: type: number format: double nullable: true value_Amount19: type: number format: double nullable: true value_Amount2: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount20: type: number format: double nullable: true value_Amount21: type: number format: double nullable: true value_Amount22: type: number format: double nullable: true value_Amount23: type: number format: double nullable: true value_Amount24: type: number format: double nullable: true value_Amount3: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount4: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount5: type: number format: double nullable: true value_Amount6: type: number format: double nullable: true value_Amount7: type: number format: double nullable: true value_Amount8: type: number format: double nullable: true value_Amount9: type: number format: double nullable: true value_Code1: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code10: maxLength: 2 type: string nullable: true value_Code11: maxLength: 2 type: string nullable: true value_Code12: maxLength: 2 type: string nullable: true value_Code13: maxLength: 2 type: string nullable: true value_Code14: maxLength: 2 type: string nullable: true value_Code15: maxLength: 2 type: string nullable: true value_Code16: maxLength: 2 type: string nullable: true value_Code17: maxLength: 2 type: string nullable: true value_Code18: maxLength: 2 type: string nullable: true value_Code19: maxLength: 2 type: string nullable: true value_Code2: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code20: maxLength: 2 type: string nullable: true value_Code21: maxLength: 2 type: string nullable: true value_Code22: maxLength: 2 type: string nullable: true value_Code23: maxLength: 2 type: string nullable: true value_Code24: maxLength: 2 type: string nullable: true value_Code3: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code4: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code5: maxLength: 2 type: string nullable: true value_Code6: maxLength: 2 type: string nullable: true value_Code7: maxLength: 2 type: string nullable: true value_Code8: maxLength: 2 type: string nullable: true value_Code9: maxLength: 2 type: string nullable: true void_Claim: type: boolean description: 'Indicates that this claim was part of a Void process. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' volume_Override: type: boolean description: 'Notes that the benefit amount, for disability claims, has been manually overridden. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' waiting_Period_Claim: type: boolean description: 'Indicates if this disability payment is a waiting period payment. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' additionalProperties: false ClaimAdjustmentConfig: type: object properties: claimNumbers: type: array items: type: integer format: int32 nullable: true newBatch: type: boolean newBatchDescription: type: string nullable: true seqList: type: string nullable: true reenterClaim: type: boolean subscriberID: type: string nullable: true memberSeq: type: string nullable: true providerID: type: string nullable: true payTo: type: string nullable: true applyBackoutExCode: type: boolean backoutExCode: type: string nullable: true autoProcessBackout: type: boolean applyReentryExCode: type: boolean reentryExCode: type: string nullable: true use_Original_Received_Date: type: boolean addNote: $ref: '#/components/schemas/NoteData' additionalProperties: false ClaimAnesthesiaModifierUnit: required: - claimAnesthesiaModifierUnit_Key - effective_Date - term_Date type: object properties: claimAnesthesiaModifierUnit_Key: type: integer format: int32 effective_Date: type: string format: date-time entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true modifier_Code: maxLength: 8 type: string nullable: true term_Date: type: string format: date-time units: type: number format: double nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimAnesthesiaModifierUnitListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAnesthesiaModifierUnitVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimAnesthesiaModifierUnit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAnesthesiaPlaceCodeUnit: required: - claimAnesthesiaPlaceCodeUnit_Key - effective_Date - term_Date type: object properties: claimAnesthesiaPlaceCodeUnit_Key: type: integer format: int32 effective_Date: type: string format: date-time entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true mnutes_Per_Unit: type: number format: double nullable: true place_Code: maxLength: 4 type: string nullable: true term_Date: type: string format: date-time update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimAnesthesiaPlaceCodeUnitListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAnesthesiaPlaceCodeUnitVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimAnesthesiaPlaceCodeUnit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAnesthesiaProcedureCodeUnit: required: - claimAnesthesiaProcedureCodeUnit_Key - effective_Date - term_Date type: object properties: claimAnesthesiaProcedureCodeUnit_Key: type: integer format: int32 effective_Date: type: string format: date-time entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true procedure_Code: maxLength: 8 type: string nullable: true term_Date: type: string format: date-time units: type: number format: double nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimAnesthesiaProcedureCodeUnitListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAnesthesiaProcedureCodeUnitVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimAnesthesiaProcedureCodeUnit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAudit: required: - audit_Percent - claimAudit_Key - suspend_Audit type: object properties: claimAudit_Key: type: integer format: int32 audit_Clause: maxLength: 4000 type: string nullable: true audit_Count: type: integer format: int32 nullable: true audit_Date: type: string format: date-time nullable: true audit_Percent: type: boolean audit_Status: maxLength: 32 type: string nullable: true audit_User: maxLength: 20 type: string nullable: true auditor_User: maxLength: 20 type: string nullable: true description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time nullable: true entry_User: maxLength: 20 type: string nullable: true event_ID: type: integer format: int32 nullable: true process_Date_Lookback: type: integer format: int32 nullable: true process_Date_Lookback_Type: maxLength: 16 type: string nullable: true suspend_Audit: type: boolean suspense_Type: maxLength: 32 type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimAuditAppealReason: required: - appeal_Reason - overturn_Reason type: object properties: appeal_Reason: maxLength: 32 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time nullable: true entry_User: maxLength: 20 type: string nullable: true overturn_Reason: type: boolean update_Date: type: string format: date-time nullable: true update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimAuditAppealReasonListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimAuditAppealReason' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditAppealReasonVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimAuditAppealReason' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditAppealResult: required: - appeal_Result type: object properties: appeal_Result: maxLength: 32 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time nullable: true entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimAuditAppealResultListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimAuditAppealResult' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditAppealResultVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimAuditAppealResult' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditClause: required: - audit_Percent - claimAuditClause_Key type: object properties: claimAuditClause_Key: type: integer format: int32 audit_Clause: maxLength: 4000 type: string nullable: true audit_Count: type: integer format: int32 nullable: true audit_Percent: type: boolean description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time nullable: true entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimAuditClauseListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimAuditClause' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditClauseVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimAuditClause' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditDetail: required: - appeal - appeal_Overturn - batch_Claim - batch_Number - claimAudit_Key - claimAuditDetail_Key type: object properties: claimAuditDetail_Key: type: integer format: int32 appeal: type: boolean appeal_Date: type: string format: date-time nullable: true appeal_Overturn: type: boolean appeal_Overturn_Date: type: string format: date-time nullable: true appeal_Overturn_Reason: maxLength: 32 type: string nullable: true appeal_Reason: maxLength: 32 type: string nullable: true appeal_Result: maxLength: 32 type: string nullable: true audit_Discrepancy: type: number format: double nullable: true batch_Claim: type: integer format: int32 batch_Number: type: integer format: int32 claimAudit_Key: type: integer format: int32 entry_Date: type: string format: date-time nullable: true entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimAuditDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimAuditDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditDetailResult: required: - audit_Result - claimAuditDetail_Key - claimAuditDetailResult_Key type: object properties: claimAuditDetailResult_Key: type: integer format: int32 audit_Result: maxLength: 32 minLength: 1 type: string claimAuditDetail_Key: type: integer format: int32 entry_Date: type: string format: date-time nullable: true entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimAuditDetailResultListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimAuditDetailResult' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditDetailResultVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimAuditDetailResult' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimAuditDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimAudit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditResult: required: - audit_Result - fail_Result - pass_Result type: object properties: audit_Result: maxLength: 32 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time nullable: true entry_User: maxLength: 20 type: string nullable: true fail_Result: type: boolean pass_Result: type: boolean update_Date: type: string format: date-time nullable: true update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimAuditResultListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimAuditResult' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditResultVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimAuditResult' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditStatus: required: - audit_Status - complete_Status type: object properties: audit_Status: maxLength: 32 minLength: 1 type: string complete_Status: type: boolean description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time nullable: true entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimAuditStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimAuditStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimAuditStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimAuditVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimAudit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatch: required: - adjustment_Claim - advance_Pay - advice_To_Pay - aeoB_Claim - auto_Flex - baseloadLookup - batch_Claim - batch_Number - calculate_Interest - capitation_Claim - context4_Override - diagnostic_Code_Type - liability_Injury - occupational - orthodontics_Treatment - other_Insurance - override_Network_ID - override_Payor_Account - partial_Disability - patient_Signature - prosthesis_Replacement - refund_Claim - related_To_Accident - related_To_Another_Party - related_To_Auto - related_To_Employment - salary_Continuation - sick_Time - subscriber_Signature - survivor_Benefit - third_Party_Payment - total_COB - transaction_837 - vacation - volume_Override - waiting_Period_Claim type: object properties: batch_Number: type: integer description: 'This value, in combination with Batch_Claim, creates a unique identifier for each claim that is maintained in both batch and processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 batch_Claim: type: integer description: 'This value, in combination with Batch_Number, creates a unique identifier for each claim that is maintained in both batch and processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 aeoB_Claim: type: boolean description: 'A flag indicating a claim is an Advanced EOB and not a claim for payment. Part of the No Surprise Act. Note: This field is marked as NOT NULL in the database and therefore required by the API.' accident_Date: type: string description: The date of accident. format: date-time nullable: true account_Key: type: integer description: 'For claim funding, indicates the payor/account this claim would be paid from.' format: int32 nullable: true adjusted_From: type: integer description: Indicates that this claim was part of an Adjustment process. format: int32 nullable: true adjustment_Claim: type: boolean description: 'Indicates this claim is part of an adjustment process. Note: This field is marked as NOT NULL in the database and therefore required by the API.' admission_Date: type: string description: 'For institutional Claims, holds the Admission Date.' format: date-time nullable: true admission_Diagnostic_Code: maxLength: 8 type: string description: The admission diagnosis code if applicable for this claim. nullable: true admission_Hour: maxLength: 8 type: string description: 'For institutional Claims, holds the Admission Hour.' nullable: true admission_Source: maxLength: 8 type: string description: 'For institutional Claims, holds the Admission Source.' nullable: true admit_Date: type: string description: Used to identify the date the member was admitted to the Hospital if hospitalized as part of this disability. format: date-time nullable: true advance_Pay: type: boolean description: 'Indicates if this claim, for disability, can be processed and paid in advance of that service dates. Note: This field is marked as NOT NULL in the database and therefore required by the API.' advice_To_Pay: type: boolean description: 'Notes this claim is advice to pay and will not go through funding. Note: This field is marked as NOT NULL in the database and therefore required by the API.' all_Docs_Rec_Date: type: string description: Information field used in custom processing and reporting. format: date-time nullable: true ambulance_DropOff_Address: maxLength: 90 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_DropOff_Address2: maxLength: 90 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_DropOff_City: maxLength: 32 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_DropOff_Location: maxLength: 64 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_DropOff_Org_Name: maxLength: 512 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_DropOff_State: maxLength: 10 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_DropOff_Zip: maxLength: 32 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_PickUp_Address: maxLength: 90 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_PickUp_Address2: maxLength: 90 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_PickUp_City: maxLength: 32 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_PickUp_Location: maxLength: 64 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_PickUp_State: maxLength: 10 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true ambulance_PickUp_Zip: maxLength: 32 type: string description: 'If the claim utlized ambulance services (submitted via 837), we track that here.' nullable: true appliance_Placed_Date: type: string description: The date the orthodontic appliance was placed. format: date-time nullable: true assumed_Care_Date: type: string description: Information field used in custom processing and reporting. format: date-time nullable: true attend_Provider_Address: maxLength: 90 type: string description: The attending provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true attend_Provider_Address2: maxLength: 90 type: string description: The attending provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true attend_Provider_City: maxLength: 30 type: string description: The attending provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true attend_Provider_Federal_ID: maxLength: 20 type: string description: The attending provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true attend_Provider_First_Name: maxLength: 25 type: string description: The attending provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true attend_Provider_Last_Name: maxLength: 35 type: string description: The attending provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true attend_Provider_MAID: maxLength: 20 type: string description: The attending provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true attend_Provider_NPI: maxLength: 20 type: string description: The attending provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true attend_Provider_Org_Name: maxLength: 512 type: string description: The attending provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true attend_Provider_Phone: maxLength: 20 type: string description: The attending provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true attend_Provider_State: maxLength: 10 type: string description: The attending provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true attend_Provider_Taxonomy: maxLength: 10 type: string description: The attending provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true attend_Provider_Zip: maxLength: 32 type: string description: The attending provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true attended_Physician_Date: type: string description: 'This identifies the date the member first visited the Physician. This field, in combination with Disabled by Physician Date and Last Day Worked, create the Disability Date for the Member.' format: date-time nullable: true auto_Flex: type: boolean description: 'For flex claims, notes that this claim was auto-created by adjudication based on configuration at the group. Note: This field is marked as NOT NULL in the database and therefore required by the API.' baseloadLookup: type: boolean description: 'Flagged when a claim has gone through the baseload provider matching service. Note: This field is marked as NOT NULL in the database and therefore required by the API.' beneficiary_ID: maxLength: 20 type: string description: Notes the beneficiary for Life & Disability claims. References the MemberBeneficiary.Beneficiary_ID. nullable: true bill_Provider_Address: maxLength: 90 type: string description: The billing provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true bill_Provider_Address2: maxLength: 90 type: string description: The billing provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true bill_Provider_City: maxLength: 30 type: string description: The billing provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true bill_Provider_Federal_ID: maxLength: 20 type: string description: The billing provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true bill_Provider_First_Name: maxLength: 25 type: string description: The billing provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true bill_Provider_Last_Name: maxLength: 35 type: string description: The billing provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true bill_Provider_MAID: maxLength: 20 type: string description: The billing provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true bill_Provider_NPI: maxLength: 20 type: string description: The billing provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true bill_Provider_Org_Name: maxLength: 512 type: string description: The billing provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true bill_Provider_Phone: maxLength: 20 type: string description: The billing provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true bill_Provider_State: maxLength: 10 type: string description: The billing provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true bill_Provider_Taxonomy: maxLength: 10 type: string description: The billing provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true bill_Provider_Zip: maxLength: 32 type: string description: The billing provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true billed_Amount: type: number description: 'Holds the claim level billed amount that is used for balancing the claim detail billed_price values. If different, throws an error.' format: double nullable: true cliA_Number: maxLength: 32 type: string description: No longer in use. nullable: true calculate_Interest: type: boolean description: 'Notes if interest was calculated for this claim as part of adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.' capitation_Claim: type: boolean description: 'Indicates if this claim is capitated. Note: This field is marked as NOT NULL in the database and therefore required by the API.' claim_837_COB: maxLength: 1 type: string description: 'For 837 transactions, indicates COB has been submitted.' nullable: true claim_ID: maxLength: 32 type: string description: An identifier assigned by external vendors and used for integrations. Primarily comes from the REF*D9 value in the 837. nullable: true claim_Priority: maxLength: 1 type: string description: 'For 837 transactions, indicates the submitted claim priority.' nullable: true claim_Status: maxLength: 8 type: string description: The status of the claim. Valid values reside in the ClaimStatus table. nullable: true claim_Type: maxLength: 20 type: string description: Notes the claim type for this claim. References ClaimType.Claim_Type. nullable: true closure_Effective_Date: type: string description: This is an information only field that allows the tracking of the Closure Effective Date. format: date-time nullable: true condition_Code1: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code10: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code11: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code12: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code13: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code14: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code15: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code16: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code17: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code18: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code19: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code2: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code20: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code21: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code22: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code23: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code24: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code3: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code4: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code5: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code6: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code7: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code8: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code9: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true context4_Override: type: boolean description: 'Allows the user to flag a claim to ignore Context4Health service results and stick to core adjudication edits. Note: This field is marked as NOT NULL in the database and therefore required by the API.' coverage_Start: type: string description: 'The patients (or Subscribers) enrollment information, references Subenrollment.Group_Coverage_Start.' format: date-time nullable: true current_Illness_Date: type: string description: The current illness date for this claim. format: date-time nullable: true drG_Code: maxLength: 4 type: string description: 'The DRG Code for this claim, if applicable. References the DRGCodes.DRG_Code.' nullable: true drG_Quantity: type: number description: The quantity associated with this DRG value. format: double nullable: true death_Cert_Rec_Date: type: string description: Information field used in custom processing and reporting. format: date-time nullable: true delivery_Date: type: string description: This identifies the date of delivery for disability due to pregnancy. format: date-time nullable: true delivery_Type: maxLength: 1 type: string description: This will identify the type of delivery that is performed as a result of pregnancy. nullable: true dep_SSDI_End_Date: type: string description: This is an information only field that allows the tracking of Dependent SSI End Date. format: date-time nullable: true diagnostic_Code1: maxLength: 8 type: string description: 'An assigned diagnostic code for this claim. This field, in the absence of a corresponding diagnosis pointer from a claim service line, indicates the primary diagnosis.' nullable: true diagnostic_Code10: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code11: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code12: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code13: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code14: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code15: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code16: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code17: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code18: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code19: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code2: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code20: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code21: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code22: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code23: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code24: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code3: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code4: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code5: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code6: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code7: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code8: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code9: maxLength: 8 type: string description: An assigned diagnostic code for this claim. nullable: true diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string description: 'Indicates if the Diagnostic Code values on this claim are ICD9 or ICD10. Two possible values: 9 - ICD9 or 0 - ICD10. Note: This field is marked as NOT NULL in the database and therefore required by the API.' disability_Date: type: string description: The calculated date of disability (or manually enetered) based on the disabilty advisor in VBASoftware. format: date-time nullable: true disability_End_Date: type: string description: Information field used in custom processing and reporting. format: date-time nullable: true disability_Type: maxLength: 20 type: string description: Used to identify the type of disability (Injury or Illness). nullable: true disabled_By_Physician: type: string description: 'This identifies the date the member was disabled by the Physician. This field, in combination with First Attended Physician Date and Last Day Worked, create the Disability Date for the Member.' format: date-time nullable: true discharge_Date: type: string description: Used to identify the date the member was discharged from the Hospital if hospitalized as part of this disability. format: date-time nullable: true discharge_Hour: maxLength: 8 type: string description: 'For institutional Claims, holds the Discharge Hour.' nullable: true division_ID: maxLength: 20 type: string description: 'The patients (or Subscribers) enrollment information, references Subenrollment.Division_ID.' nullable: true eCode_Diagnostic_Code: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code10: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code11: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code12: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code2: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code3: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code4: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code5: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code6: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code7: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code8: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true eCode_Diagnostic_Code9: maxLength: 8 type: string description: 'The external cause of injury code for this claim, if applicable.' nullable: true epsdT_Condition_Indicator1: maxLength: 3 type: string description: 'Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.' nullable: true epsdT_Condition_Indicator2: maxLength: 3 type: string description: 'Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.' nullable: true epsdT_Condition_Indicator3: maxLength: 3 type: string description: 'Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.' nullable: true epsdT_Referral_Given: maxLength: 1 type: string description: 'Early and Periodic Screening, Diagnostic, and Treatment tracking for if a referral was given for this claim.' nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true error_Amount: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Auth: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Beneficiary: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Benefit: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_ConditionCode: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Dates: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Detail: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag1: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag10: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag11: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag12: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag13: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag14: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag15: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag16: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag17: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag18: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag19: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag2: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag20: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag21: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag22: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag23: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag24: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag3: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag4: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag5: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag6: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag7: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag8: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diag9: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_ExCode1: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_ExCode2: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Exists: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Group: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Mem: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Network: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_OccurrenceCode: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Plan: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Procedure: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Prov: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Sub: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_ValueCode: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true ex_Code1: maxLength: 6 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true ex_Code2: maxLength: 6 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true ex_Code3: maxLength: 8 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true ex_Code4: maxLength: 8 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true exhaust_Date: type: string description: This is the Exhaust Date of the members Disability. format: date-time nullable: true expected_Typical_Duration: type: integer description: Expected Typical Duration (ETD) is the duration of disability identified by the MDA based on the type of job the member has as well as the diagnosis of the disability. format: int32 nullable: true ficA_Percent: type: number description: 'This will hold the FICA withhold amount for each payment. If tax calculation module is enabled, this option will be ignored.' format: double nullable: true federal_Withheld: type: number description: 'This will hold the federal withhold amount for each payment. If tax calculation module is enabled, this option will be ignored.' format: double nullable: true filing_Indicator: maxLength: 2 type: string description: No longer in use. nullable: true followUp_Date: type: string description: This will place a follow-up date on each payment as an additional identifier for when this disability should be reviewed. format: date-time nullable: true followUp_Ex_Code: maxLength: 6 type: string description: This will place a follow-up ex code on each payment to allow the user to categorize what type of follow-up is being performed. nullable: true freq_Code: maxLength: 8 type: string description: Medicare Resubmission code for the claim. Indicated in Box 22 of the claim report. nullable: true group_ID: maxLength: 20 type: string description: 'The patients (or Subscribers) enrollment information, references Subenrollment.Group_ID.' nullable: true hearing_Vision_RX_Date: type: string description: Information field used in custom processing and reporting. format: date-time nullable: true image_File_Location: maxLength: 128 type: string description: 'Stores a reference, if applicable, to an image or document associated with this claim.' nullable: true image_File_Location2: maxLength: 128 type: string description: 'Stores a reference, if applicable, to an image or document associated with this claim.' nullable: true image_File_Location3: maxLength: 128 type: string description: 'Stores a reference, if applicable, to an image or document associated with this claim.' nullable: true image_File_Location4: maxLength: 128 type: string description: 'Stores a reference, if applicable, to an image or document associated with this claim.' nullable: true initial_Treatment_Date: type: string description: Information field to track the initial treatment date for this claim. format: date-time nullable: true insured_Address: maxLength: 128 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true insured_Address2: maxLength: 128 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true insured_Alternate_ID: maxLength: 32 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true insured_Birth_Date: type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' format: date-time nullable: true insured_City: maxLength: 32 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true insured_Employer_ID: maxLength: 32 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true insured_First_Name: maxLength: 32 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true insured_ID: maxLength: 32 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true insured_Last_Name: maxLength: 32 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true insured_Phone: maxLength: 32 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true insured_Policy_Number: maxLength: 64 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true insured_SSN: maxLength: 32 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true insured_Sex: maxLength: 1 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true insured_State: maxLength: 64 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true insured_Zip: maxLength: 32 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true job_Type: maxLength: 2 type: string description: This is the job classification for the member going on disability. nullable: true ltD_Effective_Date: type: string description: This is an information only field that holds the date the member went on Long-Term Disability. format: date-time nullable: true ltD_Packet_Date: type: string description: This is an information only field that tracks the date the Long-Term Disability Packet was sent. format: date-time nullable: true last_Day_Worked: type: string description: 'This identifies the date the member last attended work prior to going on disability. This field, in combination with First Attended Physician Date and Disabled by Physician, create the Disability Date for the Member.' format: date-time nullable: true last_Physician_Warrant_Date: type: string description: This is an information only field that allows for the tracking of the Physician Warrant Date. format: date-time nullable: true last_Seen_Date: type: string description: Information field to track the last time a phyician was seen at the time of this claim submission. format: date-time nullable: true liability_Injury: type: boolean description: 'This is an information only field that identifies if this disability is a liability injury. Note: This field is marked as NOT NULL in the database and therefore required by the API.' mail_To: maxLength: 1 type: string description: Notes if the payment should be mailed to an entity other than the "Send_Check_To". nullable: true member_Seq: maxLength: 2 type: string description: The Member Sequence of the patient for this claim. nullable: true months_Of_Treatment: type: integer description: The number of months the orthodontic treatment will be. format: int32 nullable: true network_ID: maxLength: 10 type: string description: 'Indicates the network this claim was paid against. If this value is NULL, the claim is considered "Out of Network".' nullable: true note: maxLength: 24 type: string description: No longer in use. nullable: true occupational: type: boolean description: 'Notes if the disability is related to the patiens occupation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' occurrence_Code1: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code10: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code11: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code12: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code13: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code14: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code15: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code16: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code17: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code18: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code19: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code2: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code20: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code21: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code22: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code23: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code24: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code3: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code4: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code5: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code6: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code7: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code8: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code9: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Date1: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date10: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date11: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date12: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date13: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date14: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date15: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date16: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date17: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date18: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date19: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date2: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date20: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date21: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date22: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date23: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date24: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date3: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date4: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date5: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date6: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date7: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date8: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date9: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Span_Code: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code10: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code11: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code12: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code13: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code14: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code15: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code16: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code17: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code18: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code19: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code2: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code20: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code21: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code22: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code23: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code24: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code3: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code4: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code5: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code6: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code7: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code8: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code9: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_From: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From10: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From11: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From12: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From13: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From14: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From15: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From16: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From17: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From18: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From19: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From2: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From20: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From21: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From22: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From23: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From24: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From3: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From4: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From5: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From6: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From7: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From8: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From9: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru: type: string description: The occurrence span thru for this claim. format: date-time nullable: true occurrence_Span_Thru10: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru11: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru12: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru13: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru14: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru15: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru16: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru17: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru18: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru19: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru2: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru20: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru21: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru22: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru23: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru24: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru3: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru4: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru5: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru6: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru7: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru8: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru9: type: string description: The occurrence span from for this claim. format: date-time nullable: true onset_Similar_Illness_Date: type: string description: Notes the date of the original illness if this claim is associated to that illness. format: date-time nullable: true oper_Provider_Address: maxLength: 90 type: string description: The operating physician information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true oper_Provider_Address2: maxLength: 90 type: string description: The operating physician information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true oper_Provider_City: maxLength: 30 type: string description: The operating physician information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true oper_Provider_Federal_ID: maxLength: 20 type: string description: The operating physician information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true oper_Provider_First_Name: maxLength: 25 type: string description: The operating physician information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true oper_Provider_Last_Name: maxLength: 35 type: string description: The operating physician information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true oper_Provider_MAID: maxLength: 20 type: string description: The operating physician information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true oper_Provider_NPI: maxLength: 20 type: string description: The operating physician information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true oper_Provider_Org_Name: maxLength: 512 type: string description: The operating physician information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true oper_Provider_Phone: maxLength: 20 type: string description: The operating physician information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true oper_Provider_State: maxLength: 10 type: string description: The operating physician information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true oper_Provider_Taxonomy: maxLength: 10 type: string description: The operating physician information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true oper_Provider_Zip: maxLength: 32 type: string description: The operating physician information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true orthodontics_Treatment: type: boolean description: 'When this flag is checked, it indicates the dental claim is for orthodontics. Note: This field is marked as NOT NULL in the database and therefore required by the API.' other_Insurance: type: boolean description: 'Indicates if other insurance is applicable on this claim. This indicator unlocks COB amount fields on the ClaimDetail (service line). Note: This field is marked as NOT NULL in the database and therefore required by the API.' other_Procedure_Code1: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code10: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code11: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code12: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code13: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code14: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code15: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code16: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code17: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code18: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code19: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code2: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code20: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code21: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code22: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code23: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code3: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code4: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code5: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code6: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code7: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code8: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code9: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Date1: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date10: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date11: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date12: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date13: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date14: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date15: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date16: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date17: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date18: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date19: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date2: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date20: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date21: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date22: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date23: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date3: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date4: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date5: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date6: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date7: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date8: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date9: type: string description: Date associated with the additional procedure code. format: date-time nullable: true override: maxLength: 1 type: string description: No longer in use. nullable: true override_Date: type: string description: No longer in use. format: date-time nullable: true override_Network_ID: type: boolean description: 'This indicator lets the system know that the front end user has assigned this network ID and not adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Payor_Account: type: boolean description: 'Users can choose the payor from the More Information screen and this flag prevents adjudication from using the expected payor. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_User: maxLength: 16 type: string description: No longer in use. nullable: true partial_Disability: type: boolean description: 'This will identify if this is a partial disability payment. Partial Disability payments have additional tax and payment rules applied during adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.' patient_Account: maxLength: 128 type: string description: 'For the servicing provider, this indicates the patient account identifier in their practice management system.' nullable: true patient_Address: maxLength: 90 type: string description: 'For EDI submissions, this holds the Patient information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true patient_Address2: maxLength: 90 type: string description: 'For EDI submissions, this holds the Patient information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true patient_Birth_Date: type: string description: 'For EDI submissions, this holds the Patient information so it can be tracked via trigger to the ClaimPreBatch table.' format: date-time nullable: true patient_City: maxLength: 30 type: string description: 'For EDI submissions, this holds the Patient information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true patient_First_Name: maxLength: 25 type: string description: 'For EDI submissions, this holds the Patient information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true patient_ID: maxLength: 32 type: string description: 'For EDI submissions, this holds the Insured information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true patient_Last_Name: maxLength: 35 type: string description: 'For EDI submissions, this holds the Patient information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true patient_Phone: maxLength: 20 type: string description: 'For EDI submissions, this holds the Patient information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true patient_Reason_for_Visit_Diagnostic_Code1: maxLength: 8 type: string description: Reason for Visit code on Diagnosis Code 1 nullable: true patient_Reason_for_Visit_Diagnostic_Code2: maxLength: 8 type: string description: Reason for Visit code on Diagnosis Code 2 nullable: true patient_Reason_for_Visit_Diagnostic_Code3: maxLength: 8 type: string description: Reason for Visit code on Diagnosis Code 3 nullable: true patient_Relationship: maxLength: 8 type: string description: 'For EDI submissions, this holds the Patient information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true patient_Sex: maxLength: 1 type: string description: 'For EDI submissions, this holds the Patient information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true patient_Signature: type: boolean description: 'Indicates if the patient signature has been collected. Note: This field is marked as NOT NULL in the database and therefore required by the API.' patient_Signature_Date: type: string description: Indicates the date of the patient signature being collected. format: date-time nullable: true patient_State: maxLength: 50 type: string description: 'For EDI submissions, this holds the Patient information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true patient_Status: maxLength: 8 type: string description: 'For institutional Claims, holds the Patient Status.' nullable: true patient_Zip: maxLength: 32 type: string description: 'For EDI submissions, this holds the Patient information so it can be tracked via trigger to the ClaimPreBatch table.' nullable: true payToPlan_Address: maxLength: 90 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payToPlan_Address2: maxLength: 90 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payToPlan_City: maxLength: 32 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payToPlan_Claim_Office_Num: maxLength: 32 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payToPlan_ID: maxLength: 32 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payToPlan_NAIC: maxLength: 32 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payToPlan_Name: maxLength: 512 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payToPlan_State: maxLength: 10 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payToPlan_Zip: maxLength: 32 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payTo_Address: maxLength: 90 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payTo_Address2: maxLength: 90 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payTo_City: maxLength: 32 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payTo_State: maxLength: 10 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payTo_Zip: maxLength: 32 type: string description: The Pay To information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true payee_ID: maxLength: 20 type: string description: The billing provider (payee) for this claim. References the ProviderPayee.Payee_ID (by Provider_ID). nullable: true payor_Claim_Control_Number: maxLength: 64 type: string description: A claim reference number used in conjunction with the Medicare Resubmission code. Indicated in Box 22 of the claim report. nullable: true payor_ID: maxLength: 20 type: string description: 'For claim funding, indicates the payor/account this claim would be paid from.' nullable: true physician_Return_To_Work: type: string description: This is the Return to Work date identified by the Physician at the start of disability. This may or may not be the actual date the member returns to work. format: date-time nullable: true place_Of_Service: maxLength: 5 type: string description: Some transactions hold the Place of Service at the header but typically this value is empty and the ClaimDetail.Place_Of_Service is used for each service line. This value is not used in standard processing. nullable: true plan_ID: maxLength: 20 type: string description: Holds the plan the patient is enrolled in and that benefits are assigned. nullable: true plan_Provider: maxLength: 1 type: string description: No longer in use. nullable: true plan_Year: maxLength: 8 type: string description: Indicates the Plan Year this claim is processed under. This drives accumulator calculations and referneces the GroupPlanYear.Plan_Year value. nullable: true present_On_Admission1: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 1. nullable: true present_On_Admission10: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 10. nullable: true present_On_Admission11: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 11. nullable: true present_On_Admission12: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 12. nullable: true present_On_Admission13: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 13. nullable: true present_On_Admission14: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 14. nullable: true present_On_Admission15: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 15. nullable: true present_On_Admission16: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 16. nullable: true present_On_Admission17: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 17. nullable: true present_On_Admission18: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 18. nullable: true present_On_Admission19: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 19. nullable: true present_On_Admission2: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 2. nullable: true present_On_Admission20: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 20. nullable: true present_On_Admission21: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 21. nullable: true present_On_Admission22: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 22. nullable: true present_On_Admission23: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 23. nullable: true present_On_Admission24: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 24. nullable: true present_On_Admission3: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 3. nullable: true present_On_Admission4: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 4. nullable: true present_On_Admission5: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 5. nullable: true present_On_Admission6: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 6. nullable: true present_On_Admission7: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 7. nullable: true present_On_Admission8: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 8. nullable: true present_On_Admission9: maxLength: 1 type: string description: Indicates if the patient was present on admission for diagnosis 9. nullable: true present_On_Admission_ECode1: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 1. nullable: true present_On_Admission_ECode10: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 10. nullable: true present_On_Admission_ECode11: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 11. nullable: true present_On_Admission_ECode12: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 12. nullable: true present_On_Admission_ECode2: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 2. nullable: true present_On_Admission_ECode3: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 3. nullable: true present_On_Admission_ECode4: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 4. nullable: true present_On_Admission_ECode5: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 5. nullable: true present_On_Admission_ECode6: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 6. nullable: true present_On_Admission_ECode7: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 7. nullable: true present_On_Admission_ECode8: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 8. nullable: true present_On_Admission_ECode9: maxLength: 1 type: string description: Indicates if the patient was present for the external cause of injury diagnosis 9. nullable: true pricing_Method: maxLength: 8 type: string description: 'For reprice claims (typically submitted via 837), this notes the reprice method used to reprice this claim.' nullable: true pricing_Org_ID: maxLength: 50 type: string description: The ID of the pricing organization. Data is obtained in segment HCP04 on an 837. nullable: true pricing_Rate: type: number description: The rate associated with the reprice method (Pricing_Method). format: double nullable: true principal_Procedure_Code: maxLength: 8 type: string description: The principal procedure (ICD10 Diagnosis) for this claim submission. nullable: true principal_Procedure_Date: type: string description: The principal procedure date. format: date-time nullable: true prior_Placement_Date: type: string description: 'The date of a previous prosthetic or crown applied, if there was one.' format: date-time nullable: true prosthesis_Replacement: type: boolean description: 'This flag indicates if this claim is for the replacement of a prosthesis. Note: This field is marked as NOT NULL in the database and therefore required by the API.' provider_Address: maxLength: 90 type: string description: 'For EDI submissions, this holds the service provider information based on matching logic that interrogates the submitted Billing Provider, Service Provider, and Rendering Provider.' nullable: true provider_Address2: maxLength: 90 type: string description: 'For EDI submissions, this holds the service provider information based on matching logic that interrogates the submitted Billing Provider, Service Provider, and Rendering Provider.' nullable: true provider_City: maxLength: 30 type: string description: 'For EDI submissions, this holds the service provider information based on matching logic that interrogates the submitted Billing Provider, Service Provider, and Rendering Provider.' nullable: true provider_Federal_ID: maxLength: 20 type: string description: 'For EDI submissions, this holds the service provider information based on matching logic that interrogates the submitted Billing Provider, Service Provider, and Rendering Provider.' nullable: true provider_First_Name: maxLength: 30 type: string description: 'For EDI submissions, this holds the service provider information based on matching logic that interrogates the submitted Billing Provider, Service Provider, and Rendering Provider.' nullable: true provider_ID: maxLength: 20 type: string description: The provider ID of the servicing provider. References Provider.Provider_ID. nullable: true provider_Last_Name: maxLength: 30 type: string description: 'For EDI submissions, this holds the service provider information based on matching logic that interrogates the submitted Billing Provider, Service Provider, and Rendering Provider.' nullable: true provider_MAID: maxLength: 20 type: string description: 'For EDI submissions, this holds the service provider information based on matching logic that interrogates the submitted Billing Provider, Service Provider, and Rendering Provider.' nullable: true provider_NPI: maxLength: 20 type: string description: 'For EDI submissions, this holds the service provider information based on matching logic that interrogates the submitted Billing Provider, Service Provider, and Rendering Provider.' nullable: true provider_Org_Name: maxLength: 512 type: string description: 'For EDI submissions, this holds the service provider information based on matching logic that interrogates the submitted Billing Provider, Service Provider, and Rendering Provider.' nullable: true provider_Phone: maxLength: 20 type: string description: 'For EDI submissions, this holds the service provider information based on matching logic that interrogates the submitted Billing Provider, Service Provider, and Rendering Provider.' nullable: true provider_State: maxLength: 10 type: string description: 'For EDI submissions, this holds the service provider information based on matching logic that interrogates the submitted Billing Provider, Service Provider, and Rendering Provider.' nullable: true provider_Taxonomy: maxLength: 10 type: string description: 'For EDI submissions, this holds the service provider information based on matching logic that interrogates the submitted Billing Provider, Service Provider, and Rendering Provider.' nullable: true provider_Zip: maxLength: 32 type: string description: 'For EDI submissions, this holds the service provider information based on matching logic that interrogates the submitted Billing Provider, Service Provider, and Rendering Provider.' nullable: true qpA_Method: maxLength: 1 type: string description: Overrides the QPA Method set on the Plan for this claim. nullable: true ready_To_Process: maxLength: 1 type: string description: Notes if the claim is ready to process out of batch. nullable: true received_Date: type: string description: The date this claim was received into the admin system. format: date-time nullable: true ref_Provider_Address: maxLength: 90 type: string description: The referring provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true ref_Provider_Address2: maxLength: 90 type: string description: The referring provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true ref_Provider_City: maxLength: 30 type: string description: The referring provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true ref_Provider_Federal_ID: maxLength: 20 type: string description: The referring provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true ref_Provider_First_Name: maxLength: 25 type: string description: The referring provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true ref_Provider_Last_Name: maxLength: 35 type: string description: The referring provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true ref_Provider_MAID: maxLength: 20 type: string description: The referring provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true ref_Provider_NPI: maxLength: 20 type: string description: The referring provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true ref_Provider_Org_Name: maxLength: 512 type: string description: The referring provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true ref_Provider_Phone: maxLength: 20 type: string description: The referring provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true ref_Provider_State: maxLength: 10 type: string description: The referring provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true ref_Provider_Taxonomy: maxLength: 10 type: string description: The referring provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true ref_Provider_Zip: maxLength: 32 type: string description: The referring provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true referred_By: maxLength: 30 type: string description: Information field to track if a referral was sent for this claim. nullable: true refund_Check_ID: type: integer description: Indicates that this claim was part of a Void process. format: int32 nullable: true refund_Claim: type: boolean description: 'Indicates this claim is part of a refund process. Note: This field is marked as NOT NULL in the database and therefore required by the API.' refund_Funding_Key: type: integer description: 'If this claim was part of a refund process, this will hold the reference to the receipt generated by the refund process.' format: int32 nullable: true related_To_Accident: type: boolean description: 'Indicates if the claim is related to a non-car accident. Note: This field is marked as NOT NULL in the database and therefore required by the API.' related_To_Another_Party: type: boolean description: 'Indicates if the claim was casued by a third party. Note: This field is marked as NOT NULL in the database and therefore required by the API.' related_To_Auto: type: boolean description: 'Indicates if the claim is related to a car accident. Note: This field is marked as NOT NULL in the database and therefore required by the API.' related_To_Employment: type: boolean description: 'Indicates if the claim is work related. Note: This field is marked as NOT NULL in the database and therefore required by the API.' relinquished_Care_Date: type: string description: Information field used in custom processing and reporting. format: date-time nullable: true rend_Provider_Address: maxLength: 90 type: string description: The rendering provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true rend_Provider_Address2: maxLength: 90 type: string description: The rendering provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true rend_Provider_City: maxLength: 30 type: string description: The rendering provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true rend_Provider_Federal_ID: maxLength: 20 type: string description: The rendering provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true rend_Provider_First_Name: maxLength: 25 type: string description: The rendering provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true rend_Provider_Last_Name: maxLength: 35 type: string description: The rendering provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true rend_Provider_MAID: maxLength: 20 type: string description: The rendering provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true rend_Provider_NPI: maxLength: 20 type: string description: The rendering provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true rend_Provider_Org_Name: maxLength: 512 type: string description: The rendering provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true rend_Provider_Phone: maxLength: 20 type: string description: The rendering provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true rend_Provider_State: maxLength: 10 type: string description: The rendering provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true rend_Provider_Taxonomy: maxLength: 10 type: string description: The rendering provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true rend_Provider_Zip: maxLength: 32 type: string description: The rendering provider information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true repriced_Network_ID: maxLength: 10 type: string description: 'As part of reprice claim submissions (via 837), this will hold the repricing network.' nullable: true return_To_Work_Date: type: string description: This is the date the member Returned to Work. This date affects the total payments created as well as other calculations during adjudication. format: date-time nullable: true salary_Continuation: type: boolean description: 'This flag identifies that there is salary continuation during this disability. Note: This field is marked as NOT NULL in the database and therefore required by the API.' send_Check_To: maxLength: 1 type: string description: 'Indicates the entity that should be paid for this claim. S - Subscriber, G - Group, B - Beneficiary, P - Payee, or V - Provider.' nullable: true sender_ID: maxLength: 15 type: string description: The Sender ID sent inbound for x12 (837) transactions. nullable: true service_Date: type: string description: The earliest Service_Date of all service lines on this claim. format: date-time nullable: true service_Fac_Loc_Address: maxLength: 90 type: string description: The service facility information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true service_Fac_Loc_Address2: maxLength: 90 type: string description: The service facility information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true service_Fac_Loc_City: maxLength: 30 type: string description: The service facility information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true service_Fac_Loc_Federal_ID: maxLength: 20 type: string description: The service facility information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true service_Fac_Loc_First_Name: maxLength: 25 type: string description: The service facility information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true service_Fac_Loc_Last_Name: maxLength: 35 type: string description: The service facility information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true service_Fac_Loc_MAID: maxLength: 20 type: string description: The service facility information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true service_Fac_Loc_NPI: maxLength: 20 type: string description: The service facility information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true service_Fac_Loc_Org_Name: maxLength: 512 type: string description: The service facility information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true service_Fac_Loc_Phone: maxLength: 20 type: string description: The service facility information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true service_Fac_Loc_State: maxLength: 10 type: string description: The service facility information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true service_Fac_Loc_Taxonomy: maxLength: 10 type: string description: The service facility information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true service_Fac_Loc_Zip: maxLength: 32 type: string description: The service facility information as submitted on the 837. This field is used for tracking via trigger to the ClaimPreBatch. nullable: true service_Thru: type: string description: The latest Service_Thru for all service lines on this claim. format: date-time nullable: true sick_Time: type: boolean description: 'This flag identifies that there is sick time during this disability. Note: This field is marked as NOT NULL in the database and therefore required by the API.' statement_From_Date: type: string description: 'For Institutional Claims, holds the Statement Date.' format: date-time nullable: true statement_Thru_Date: type: string description: 'For Institutional Claims, holds the Statement Date.' format: date-time nullable: true subscriber_ID: maxLength: 9 type: string description: The Subscriber ID of the patient for this claim. nullable: true subscriber_Signature: type: boolean description: 'Indicates if the insured signature has been collected. Note: This field is marked as NOT NULL in the database and therefore required by the API.' survivor_Benefit: type: boolean description: 'Indicates if Survivor Benefit was applied for this disability payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.' third_Party_Payment: type: boolean description: 'For disability, indicates if this professional claim is a 3rd party payment (typically related to alimony, garnishment, etc.) Note: This field is marked as NOT NULL in the database and therefore required by the API.' total_COB: type: number description: 'COB total for all claim detail lines Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double trading_Partner_Key: type: integer description: No longer in use. format: int32 nullable: true trans_837_Control_Num: maxLength: 9 type: string description: 'For 837 transactions, this is the control number assgined by the submitter.' nullable: true transaction_837: type: boolean description: 'Indicates this is a claim entered by an inbound 837. Note: This field is marked as NOT NULL in the database and therefore required by the API.' transaction_837_ID: maxLength: 30 type: string description: 'For 837 transactions, this holds the transaction ID assigned by the submission.' nullable: true type_Of_Admission: maxLength: 6 type: string description: The Admission Type associated to this claim. nullable: true type_Of_Bill: maxLength: 6 type: string description: The Bill Type associated to this claim. References BillType.Type_Of_Bill. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true vacation: type: boolean description: 'This flag identifies that there is vacation during this disability. Note: This field is marked as NOT NULL in the database and therefore required by the API.' value_Amount1: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount10: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount11: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount12: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount13: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount14: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount15: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount16: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount17: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount18: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount19: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount2: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount20: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount21: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount22: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount23: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount24: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount3: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount4: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount5: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount6: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount7: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount8: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount9: type: number description: The monetary amount related to the value code. format: double nullable: true value_Code1: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code10: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code11: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code12: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code13: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code14: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code15: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code16: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code17: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code18: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code19: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code2: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code20: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code21: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code22: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code23: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code24: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code3: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code4: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code5: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code6: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code7: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code8: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code9: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true void_Check_ID: type: integer description: Indicates that this claim was part of a Refund process. format: int32 nullable: true volume_Override: type: boolean description: 'Notes that the benefit amount, for disability claims, has been manually overridden. Note: This field is marked as NOT NULL in the database and therefore required by the API.' waiting_Period_Claim: type: boolean description: 'Indicates if this disability payment is a waiting period payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false ClaimBatchDetail: required: - adjustment_Seq - batch_Claim - batch_Number - billed_Price - buccal - capitation_Claim - claim_Seq - co_Ins_Amt - co_Pay_Amt - coB_Amt - deductible_Amt - discount_Amt - distal - facial - federal_Tax - fica - incisal - interest - labial - lingual - mesial - not_Covered_Amt - occlusal - override_Benefit_Code - override_Co_Ins_Amt - override_Co_Pay_Amt - override_COB_Amt - override_Ded_Credit_Amt - override_Deductible_Amt - override_Federal_Tax - override_Local_Tax - override_Medicare_Tax - override_Not_Covered_Amt - override_Plan_Price - override_Social_Security - override_State_Tax - override_With_Hold_Amt - paid_Amt - partial_Loss - plan_Price - premium_Deduction - principal - root - social_Security - state_Tax - ucR_Price - with_Hold_Amt type: object properties: batch_Number: type: integer description: 'References the ClaimBatch.Batch_Number value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 batch_Claim: type: integer description: 'References the ClaimBatch.Batch_Claim value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 claim_Seq: maxLength: 2 minLength: 1 type: string description: 'In combination with Adjustment_Seq, creates a unique sequence for each service line on this claim.' adjustment_Seq: maxLength: 3 minLength: 1 type: string description: 'In combination with Claim_Seq, creates a unique sequence for each service line on this claim. Used to note adjustments, cascading, etc. when utlized. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ansI_Code: maxLength: 8 type: string description: No longer in use. nullable: true apC_Code: maxLength: 8 type: string description: The APC code applied to this service if identified for calculation during adjudication. nullable: true account_Key: type: integer description: 'For reference purposes, this hold the individual service line funding payor/account. If multiple payor/accounts are found on different service lines for the same claim, adjudication spits out an error.' format: int32 nullable: true adjusted_From_Adjustment_Line: maxLength: 3 type: string description: References the Adjustment_Seq value on the original claim that this claim is adjusting. nullable: true adjusted_From_Line: maxLength: 2 type: string description: References the Claim_Seq value on the original claim that this claim is adjusting. nullable: true auth_Number: maxLength: 20 type: string description: The Auth Number for services that require authorization. References Auth.Auth_Number. nullable: true auth_Penalty: type: number description: 'If an Auth Penalty is applied during adjudication, that is housed here.' format: double nullable: true auth_Required: maxLength: 1 type: string description: Notes that this service lines required authorization. nullable: true benefit_Code: maxLength: 10 type: string description: This is the benefit code assigned to this service line based on the Plan assigned on the Claim header. References BenefitCodes.Benefit_Code. nullable: true benefit_Rate_Applied: type: number description: Benefit Rate being applied to this detail line. format: double nullable: true billed_Price: type: number description: 'The billed charges assigned by the provider for this service. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double brand_Indicator: maxLength: 1 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true buccal: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' cliA_Number: maxLength: 32 type: string description: No longer in use. nullable: true coB_Amt: type: number description: 'Holds the Other Insurance calculated amount that would affect the payable amount for this service (calculated from COB_Hold, COB_Mem_Resp, COB_Savings, and COB_Savings_Used). Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coB_Hold: type: number description: Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied. format: double nullable: true coB_Mem_Resp: type: number description: Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied. format: double nullable: true coB_Savings: type: number description: Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied. format: double nullable: true coB_Savings_Used: type: number description: Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied. format: double nullable: true calendar_Year: maxLength: 4 type: string description: Used for Flex Claims to indicate the calendar year this claim applies. nullable: true capitation_Claim: type: boolean description: 'Notes if this service line is captiated. If the Claim.Capitation_Claim value is flagged, it overrides this value and notes the entire claim and all service lines as capitated. Note: This field is marked as NOT NULL in the database and therefore required by the API.' check_ID: type: integer description: No longer in use. format: int32 nullable: true co_Ins_Amt: type: number description: 'The co-insurance amount applied by adjudication based on benefit definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double co_Pay_Amt: type: number description: 'The co-pay amount applied by adjudication based on benefit definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double currency_ID: maxLength: 16 type: string description: 'For currency calculations, this holds the destination currency.' nullable: true days_Supply: type: integer description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: int32 nullable: true ded_Credit_Amt: type: number description: 'If the service is eligiblity for deductible credits, they would be stored here.' format: double nullable: true deductible_Amt: type: number description: 'The deductible amount applied by adjudication based on benefit definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double detail_Plan_Year: maxLength: 8 type: string description: Indicates which Plan Year the service line correlates to from GroupPlanYear.Plan_Year nullable: true diagnosis_Code: maxLength: 8 type: string description: The diagnosis pointer for this service line indicating which Diagnostic Codes from the Claim are applicable to this service. nullable: true discount_Amt: type: number description: 'The difference between Billed and Allowed is stored as the Discount Amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double dispense_As_Written: type: integer description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: int32 nullable: true distal: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' drug_Code: maxLength: 20 type: string description: For RX claims or medical claims that hold a drug code. References DrugCode.Drug_Code. nullable: true drug_Quantity: type: number description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: double nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true error_Auth: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Benefit: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Count: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Covered: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Dates: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Diagnosis: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_ExCode: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Modifier: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Place: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Price: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true error_Procedure: maxLength: 1 type: string description: 'During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.' nullable: true ex_Code: maxLength: 6 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true ex_Code2: maxLength: 6 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true ex_Code3: maxLength: 6 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true fica: type: number description: 'The FICA tax amount for disability claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double facial: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' federal_Amount_To_Tax: type: number description: 'Based on taxable amount and various configurations, this holds the Federal "To Tax" amount for disability claim.' format: double nullable: true federal_Tax: type: number description: 'The calculated Federal tax amount based on the "To Tax" amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double federal_Tax_Flat: type: number description: A flat federal tax amount applied in addition to the calculated tax amount. format: double nullable: true fill_Date: type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: date-time nullable: true flex_Description: maxLength: 128 type: string description: Manually entered description of this flex claim. nullable: true formulary_Indicator: maxLength: 1 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true incisal: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' interest: type: number description: 'If interest is calculated on a claim, it is stored here and applied to payable amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double labial: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' life_Benefit: maxLength: 10 type: string description: The Life Benefit to be applied for Life claims processing. nullable: true life_Benefit_Volume: type: number description: The Life Benefit calculated volume based on benefit definition. format: double nullable: true line_Control_Number: maxLength: 64 type: string description: Number added manually to claims and from 837 files and sent outbound on 835 files. nullable: true lingual: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' local_Tax: type: number description: 'If a locality tax is applicable it would be housed here. Note: The database will apply a default value of `0` for this field if a value is not provided.' format: double nullable: true mail_Order_Indicator: maxLength: 1 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true medicare_Amount_To_Tax: type: number description: 'Based on taxable amount and various configurations, this holds the Medicare "To Tax" amount for disability claim.' format: double nullable: true medicare_Tax: type: number description: The calculated Medicare tax amount based on the "To Tax" amount. format: double nullable: true mesial: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' minutes_Per_Unit: type: number description: 'This is for anesthesia, each Unit of anesthesia is equal to a specific amount of Minutes.' format: double nullable: true modifier: maxLength: 8 type: string description: The modifier applied to this service. nullable: true modifier_2: maxLength: 8 type: string description: The modifier applied to this service. nullable: true modifier_3: maxLength: 8 type: string description: The modifier applied to this service. nullable: true modifier_4: maxLength: 8 type: string description: The modifier applied to this service. nullable: true modifier_Units: type: number description: The number of the units from this detail line that comes from the Modifier. This determines pricing for the line. format: double nullable: true not_Covered_Amt: type: number description: 'For not covered services, or partially not covered services, this reflects that deduction. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double occlusal: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' oral_Cavity_Designation_Code_1: maxLength: 3 type: string description: For dental claims this holds the oral cavity designation sent on the 837D. nullable: true oral_Cavity_Designation_Code_2: maxLength: 3 type: string description: For dental claims this holds the oral cavity designation sent on the 837D. nullable: true oral_Cavity_Designation_Code_3: maxLength: 3 type: string description: For dental claims this holds the oral cavity designation sent on the 837D. nullable: true oral_Cavity_Designation_Code_4: maxLength: 3 type: string description: For dental claims this holds the oral cavity designation sent on the 837D. nullable: true oral_Cavity_Designation_Code_5: maxLength: 3 type: string description: For dental claims this holds the oral cavity designation sent on the 837D. nullable: true other_Deduction_Amount: type: number description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: double nullable: true override_Benefit_Code: type: boolean description: 'This flag indicates if the benefit code has been overridden. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_COB_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Co_Ins_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Co_Pay_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Ded_Credit_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Deductible_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Federal_Tax: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Local_Tax: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Medicare_Tax: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Not_Covered_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Plan_Price: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Social_Security: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_State_Tax: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_With_Hold_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ppO_Price_Plan_Price_Diff: type: number description: Information field used in custom processing and reporting. format: double nullable: true paid_Amt: type: number description: 'The final paid amount for this service line based on allowed amount (Plan_Price) minus all applicable deductions. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double partial_Loss: type: number description: 'The partial loss amount for disability claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double payor_ID: maxLength: 20 type: string description: 'For reference purposes, this hold the individual service line funding payor/account. If multiple payor/accounts are found on different service lines for the same claim, adjudication spits out an error.' nullable: true pharmacy_Name: maxLength: 128 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true place_Of_Service: maxLength: 5 type: string description: The place of service for the services being rendered on this service line. nullable: true plan_Price: type: number description: 'The allowed amount for this service based on fee schedule, pricing, repricing, etc. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double premium_Deduction: type: number description: 'The premium deduction amount for disability claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double prescriber_ID: maxLength: 32 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true prescription_Date: type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: date-time nullable: true prescription_Number: maxLength: 50 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true pricing_Method: maxLength: 8 type: string description: 'For reprice claims (typically submitted via 837), this notes the reprice method used to reprice this service line.' nullable: true pricing_Rate: type: number description: The rate associated with the reprice method (Pricing_Method). format: double nullable: true principal: type: number description: 'For life claims, this holds the principal amount for reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double procedure_Code: maxLength: 8 type: string description: The service being rendered on this claim. nullable: true procedure_Code2: maxLength: 8 type: string description: The secondary service being rendered on this claim. nullable: true procedure_Code_Units: type: number description: The number of th eunits from this detail line that comes from the Prtocedure Code. This determines pricing for the line. format: double nullable: true qualifying_Payment_Amount: type: number description: QPA (Qualified Payment Amount) values received in upcoming EDI transactions for the NSA (No Surprise Act) mandate. format: double nullable: true reason_Code: type: integer description: No longer in use. format: int32 nullable: true refill_Indicator: type: integer description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: int32 nullable: true repriced_Savings_Amount: type: number description: Holds the submitted reprice savings amount for services that include this amount in the pricing calculation. format: double nullable: true root: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' service_Date: type: string description: The start date of the services being rendered. format: date-time nullable: true service_Thru: type: string description: The end date of the services being rendered. format: date-time nullable: true socSec_Amount_To_Tax: type: number description: 'Based on taxable amount and various configurations, this holds the Social Security "To Tax" amount for disability claim.' format: double nullable: true social_Security: type: number description: 'The calculated Social Security tax amount based on the "To Tax" amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double state_Amount_To_Tax: type: number description: 'Based on taxable amount and various configurations, this holds the State "To Tax" amount for disability claim.' format: double nullable: true state_Tax: type: number description: 'The calculated State tax amount based on the "To Tax" amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double state_Tax_Flat: type: number description: A flat state tax amount applied in addition to the calculated tax amount. format: double nullable: true state_Tax_State: maxLength: 2 type: string description: 'When state taxes are calculated, this indicates the state the tax amount was calculated against.' nullable: true status_Code: maxLength: 1 type: string description: 'Holds the individaul status of this service line based on Ex Codes. A - Payable, D - Denied, E - Pended.' nullable: true svc_Count: type: number description: The units applied to this service. format: double nullable: true taxable_Amount: type: number description: This holds the starting taxable amount based on pre-tax and pre-gross deductions applied to this service. format: double nullable: true tooth_Number: type: integer description: 'For dental claims, this identifies the tooth, quadrant or arch being worked for this service.' format: int32 nullable: true ucR_Price: type: number description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double unit_Dose: type: integer description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: int32 nullable: true unit_Of_Measure: maxLength: 2 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true with_Hold_Amt: type: number description: 'For plans that allow withhold, this amount is used to track that amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double additionalProperties: false ClaimBatchDetailBenefit: required: - adjustment_Seq - batch_Claim - batch_Number - benefit_Code - claim_Seq - override type: object properties: batch_Number: type: integer format: int32 batch_Claim: type: integer format: int32 claim_Seq: maxLength: 2 minLength: 1 type: string adjustment_Seq: maxLength: 3 minLength: 1 type: string benefit_Code: maxLength: 10 minLength: 1 type: string override: type: boolean override_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimBatchDetailBenefitListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimBatchDetailBenefit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchDetailBenefitVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimBatchDetailBenefit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimBatchDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimBatchDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchLife: required: - batch_Number - diagnostic_Code_Type - illness type: object properties: batch_Number: type: integer format: int32 claim_ID: maxLength: 32 type: string nullable: true death_Date: type: string format: date-time nullable: true death_Reason: type: integer format: int32 nullable: true diagnostic_Code1: maxLength: 8 type: string nullable: true diagnostic_Code2: maxLength: 8 type: string nullable: true diagnostic_Code3: maxLength: 8 type: string nullable: true diagnostic_Code4: maxLength: 8 type: string nullable: true diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true ex_Code1: maxLength: 6 type: string nullable: true ex_Code2: maxLength: 6 type: string nullable: true illness: type: boolean illness_Duration: type: integer format: int32 nullable: true illness_Duration_Type: maxLength: 1 type: string nullable: true last_Day_Worked: type: string format: date-time nullable: true mail_To: maxLength: 1 type: string nullable: true member_Seq: maxLength: 2 type: string nullable: true pay_To: maxLength: 1 type: string nullable: true payee_ID: maxLength: 20 type: string nullable: true plan_ID: maxLength: 20 type: string nullable: true provider_ID: maxLength: 20 type: string nullable: true received_Date: type: string format: date-time nullable: true subscriber_ID: maxLength: 9 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true volume: type: number format: double nullable: true additionalProperties: false ClaimBatchLifeBenefit: required: - batch_Number - benefit_Code type: object properties: batch_Number: type: integer format: int32 benefit_Code: maxLength: 10 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true volume: type: number format: double nullable: true additionalProperties: false ClaimBatchLifeBenefitListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimBatchLifeBenefit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchLifeBenefitVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimBatchLifeBenefit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchLifeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimBatchLife' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchLifeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimBatchLife' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimBatch' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchLog: required: - batch_Claim - batch_Number - claimBatchLog_Key - job_Key type: object properties: claimBatchLog_Key: type: integer description: 'No longer in use. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 batch_Claim: type: integer description: 'No longer in use. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 batch_Number: type: integer description: 'No longer in use. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 entry_Date: type: string description: No longer in use. format: date-time entry_User: maxLength: 20 type: string description: No longer in use. nullable: true job_Key: type: integer description: 'No longer in use. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 log_Action: maxLength: 256 type: string description: No longer in use. nullable: true log_Date: type: string description: No longer in use. format: date-time nullable: true log_Message: maxLength: 4000 type: string description: No longer in use. nullable: true log_Result: maxLength: 256 type: string description: No longer in use. nullable: true update_Date: type: string description: No longer in use. format: date-time update_User: maxLength: 20 type: string description: No longer in use. nullable: true additionalProperties: false ClaimBatchLogListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimBatchLog' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchLogVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimBatchLog' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchPlan: required: - batch_Claim - batch_Number - plan_ID type: object properties: batch_Number: type: integer format: int32 batch_Claim: type: integer format: int32 plan_ID: maxLength: 20 minLength: 1 type: string additionalProperties: false ClaimBatchPlanListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimBatchPlan' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchPlanVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimBatchPlan' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchReference: required: - original_Batch_Claim - original_Batch_Number - reference_Type - referenced_Batch_Claim - referenced_Batch_Number type: object properties: original_Batch_Number: type: integer description: 'When one claim must reference another claim, this holds the pointer to the original batch/claim. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 original_Batch_Claim: type: integer description: 'When one claim must reference another claim, this holds the pointer to the original batch/claim. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 referenced_Batch_Number: type: integer description: 'When one claim must reference another claim, this holds the pointer to the referenced batch/claim. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 referenced_Batch_Claim: type: integer description: 'When one claim must reference another claim, this holds the pointer to the referenced batch/claim. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 reference_Type: maxLength: 16 minLength: 1 type: string description: 'When one claim must reference another claim, this holds the type of reference being created.' entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true reference_Date: type: string description: 'When one claim must reference another claim, this holds the date of that reference being made.' format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ClaimBatchReferenceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimBatchReference' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchReferenceVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimBatchReference' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchType: required: - batch_Type type: object properties: batch_Type: maxLength: 16 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimBatchTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimBatchType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimBatchType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimBatch' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatch_ClaimBatchDetail: type: object properties: claimBatch: $ref: '#/components/schemas/ClaimBatch' claimBatchDetails: type: array items: $ref: '#/components/schemas/ClaimBatchDetail' nullable: true additionalProperties: false ClaimBatch_ClaimBatchDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimBatch_ClaimBatchDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatch_ClaimBatchDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimBatch_ClaimBatchDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatches: required: - batch_Number - process_By_Disability_Date - use_Default_Date type: object properties: batch_Number: type: integer format: int32 batch_Type: maxLength: 16 type: string nullable: true case_Status: maxLength: 8 type: string nullable: true case_Status_Date: type: string format: date-time nullable: true case_Status_Reason: maxLength: 8 type: string nullable: true case_Status_User: maxLength: 20 type: string nullable: true current_Phys_Tax_ID: maxLength: 20 type: string nullable: true default_Claim_Type: maxLength: 20 type: string nullable: true default_Date: type: string format: date-time nullable: true default_Plan_Type: maxLength: 6 type: string nullable: true default_Plan_Type2: maxLength: 6 type: string nullable: true default_Plan_Type3: maxLength: 6 type: string nullable: true description: maxLength: 64 type: string nullable: true edI_Key: type: integer format: int32 nullable: true edI_Location: maxLength: 16 type: string nullable: true edI_Source_File_Name: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true member_Seq: maxLength: 2 type: string nullable: true original_Claim_Count: type: integer format: int32 nullable: true original_Phys_Tax_ID: maxLength: 20 type: string nullable: true overpayment_Ex_Code: maxLength: 6 type: string nullable: true overpayment_Total: type: number format: double nullable: true process_By_Disability_Date: type: boolean reviewed_Date: type: string format: date-time nullable: true reviewed_Status: maxLength: 6 type: string nullable: true reviewed_User: maxLength: 20 type: string nullable: true status: maxLength: 16 type: string nullable: true subscriber_ID: maxLength: 9 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true use_Default_Date: type: boolean additionalProperties: false ClaimBatchesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimBatches' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchesStatus: required: - status type: object properties: status: maxLength: 16 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time nullable: true entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimBatchesStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimBatchesStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchesStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimBatchesStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimBatchesVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimBatches' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimCodingRule: required: - claimCodingRule_Key type: object properties: claimCodingRule_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true procedure_Cluster: maxLength: 32 type: string nullable: true rule_Description: maxLength: 2048 type: string nullable: true rule_Ex_Code: maxLength: 6 type: string nullable: true rule_Name: maxLength: 256 type: string nullable: true rule_Range: type: integer format: int32 nullable: true rule_Range_Type: maxLength: 1 type: string nullable: true rule_Type: maxLength: 16 type: string nullable: true rule_Type_Net: maxLength: 1 type: string nullable: true rule_Type_Quantity: type: number format: double nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimCodingRuleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimCodingRule' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimCodingRuleType: required: - rule_Type type: object properties: rule_Type: maxLength: 16 minLength: 1 type: string description: maxLength: 2048 type: string nullable: true display: maxLength: 64 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimCodingRuleTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimCodingRuleType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimCodingRuleTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimCodingRuleType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimCodingRuleVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimCodingRule' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimConditionCode: required: - condition_Code type: object properties: condition_Code: maxLength: 8 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimConditionCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimConditionCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimConditionCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimConditionCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimCustomExCodeRule: required: - claimCustomExCodeRule_Key - use_Detail_Ex_Code type: object properties: claimCustomExCodeRule_Key: type: integer description: 'Unique identifier for each custom Ex Code rule. This takes the combination of fields on this table and, if a claim fits in the configuration, assigns an ex code. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 benefit_Code: maxLength: 10 type: string description: Benefit code associated with the selected custom ExCode rule. nullable: true claim_Type: maxLength: 20 type: string description: The Claim Type for this Custom Ex Code rule. nullable: true date_Type: maxLength: 16 type: string description: 'The Date Type (service date, received date, etc.) to use in combination with effective dates to deterine if this rule applies.' nullable: true detail_Amount: type: number description: 'The amount you want this edit to compare against. For example, if you wanted to apply a custom ex code for any claim with a Co Insurance greater than $50, you would set Detail_Amount_Field = "co_ins_amt", set the Detail_Amount_Field_Operator to ">", then set the Detail_Amount field to 50.00.' format: double nullable: true detail_Amount_Field: maxLength: 64 type: string description: 'The detail amount field drives the logic for what the Field Operator and Amount are compared against on the Service line: payable_amount: The amount payable based on rules applied (Allowed - (copay, coins, deductible, not covered, etc.). billed_price: The amount billed, represented by the Billed_Price field. plan_price: The price associated with the plan, represented by the Plan_Price field. deductible_amt: The deductible amount, represented by the Deductible_Amt field. co_pay_amt: The co-payment amount, represented by the Co_Pay_Amt field. co_ins_amt: The co-insurance amount, represented by the Co_Ins_Amt field. cob_amt: The coordination of benefits amount, represented by the COB_Amt field. cob_hold: The coordination of benefits hold amount, represented by the COB_Hold field. cob_mem_resp: The coordination of benefits member responsibility, represented by the COB_Mem_Resp field. mem_resp: The total member responsibility, calculated as the sum of Co_Ins_Amt, Co_Pay_Amt, and Deductible_Amt.' nullable: true detail_Amount_Field_Operator: maxLength: 32 type: string description: 'Simple operator (Greater than, less than, or equal). This compares the value identified in Detail_Amount_Field against the value in the Detail_Amount field based on this opeator.' nullable: true division_ID: maxLength: 20 type: string description: The Division ID for this Custom Ex Code rule. nullable: true effective_Date: type: string description: Effective Date for this Custom Ex Code rule. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: The Ex Code that is applied if the identified criteria matched a claim during adjudication. nullable: true federal_ID: maxLength: 20 type: string description: The Tax ID for this Custom Ex Code rule. nullable: true from_Diag_Code: maxLength: 8 type: string description: The Diagnosis Range for this Custom Ex Code rule. nullable: true from_Procedure: maxLength: 8 type: string description: The Procedure Range for this Custom Ex Code rule. nullable: true group_ID: maxLength: 20 type: string description: The Group ID for this Custom Ex Code rule. nullable: true member_Seq: maxLength: 2 type: string description: The Member Sequence for this Custom Ex Code rule. nullable: true network_Option: maxLength: 6 type: string description: 'Option that allows custom claim rules to be applied in network, out of network or in all cases' nullable: true plan_ID: maxLength: 20 type: string description: The Plan ID for this Custom Ex Code rule. nullable: true provider_ID: maxLength: 20 type: string description: The Provider ID for this Custom Ex Code rule. nullable: true subscriber_ID: maxLength: 9 type: string description: The Subscriber ID for this Custom Ex Code rule. nullable: true term_Date: type: string description: Term Date for this Custom Ex Code rule. format: date-time nullable: true thru_Diag_Code: maxLength: 8 type: string description: The Diagnosis Range for this Custom Ex Code rule. nullable: true thru_Procedure: maxLength: 8 type: string description: The Procedure Range for this Custom Ex Code rule. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true use_Detail_Ex_Code: type: boolean description: 'Indicates that this Custom Ex Code rule is going to apply the resulting Ex Code to the Service Line rather than the header. This assumes the use of Benefit_Code and the Detail_Amount fields. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false ClaimCustomExCodeRuleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimCustomExCodeRule' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimCustomExCodeRuleVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimCustomExCodeRule' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimDeductionType: required: - deduction_Type - pre_Gross - pre_Tax type: object properties: deduction_Type: maxLength: 8 minLength: 1 type: string description: maxLength: 64 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true pre_Gross: type: boolean pre_Tax: type: boolean update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimDeductionTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimDeductionType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimDeductionTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimDeductionType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimDetail: required: - adjusted_Line - adjustment_Seq - admin_Amt - billed_Price - buccal - capitation_Claim - claim_Number - claim_Seq - co_Ins_Amt - co_Pay_Amt - coB_Amt - deductible_Amt - discount_Amt - distal - facial - federal_Tax - fica - incisal - interest - labial - lingual - mesial - not_Covered_Amt - occlusal - override_Benefit_Code - override_Co_Ins_Amt - override_Co_Pay_Amt - override_COB_Amt - override_Ded_Credit_Amt - override_Deductible_Amt - override_Federal_Tax - override_Local_Tax - override_Medicare_Tax - override_Not_Covered_Amt - override_Plan_Price - override_Social_Security - override_State_Tax - override_With_Hold_Amt - paid_Amt - partial_Loss - plan_Price - premium_Deduction - principal - root - social_Security - state_Tax - ucR_Price - with_Hold_Amt type: object properties: claim_Number: type: integer description: 'References the Claim.Claim_Number value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 claim_Seq: maxLength: 2 minLength: 1 type: string description: 'In combination with Adjustment_Seq, creates a unique sequence for each service line on this claim.' adjustment_Seq: maxLength: 3 minLength: 1 type: string description: 'In combination with Claim_Seq, creates a unique sequence for each service line on this claim. Used to note adjustments, cascading, etc. when utlized. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ansI_Code: maxLength: 8 type: string description: No longer in use. nullable: true apC_Code: maxLength: 8 type: string description: The APC code applied to this service if identified for calculation during adjudication. nullable: true account_Key: type: integer description: 'For reference purposes, this hold the individual service line funding payor/account. If multiple payor/accounts are found on different service lines for the same claim, adjudication spits out an error.' format: int32 nullable: true adjusted_Line: type: boolean description: 'Notes if this line was adjusted as part of an individual claim adjustment process. Note: This field is marked as NOT NULL in the database and therefore required by the API.' admin_Amt: type: number description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double auth_Number: maxLength: 20 type: string description: The Auth Number for services that require authorization. References Auth.Auth_Number. nullable: true auth_Penalty: type: number description: 'If an Auth Penalty is applied during adjudication, that is housed here.' format: double nullable: true auth_Required: maxLength: 1 type: string description: Notes that this service lines required authorization. nullable: true benefit_Code: maxLength: 10 type: string description: This is the benefit code assigned to this service line based on the Plan assigned on the Claim header. References BenefitCodes.Benefit_Code. nullable: true benefit_Rate_Applied: type: number description: Benefit Rate being applied to this detail line. format: double nullable: true billed_Price: type: number description: 'The billed charges assigned by the provider for this service. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double brand_Indicator: maxLength: 1 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true buccal: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' cliA_Number: maxLength: 32 type: string description: No longer in use. nullable: true coB_Amt: type: number description: 'Holds the Other Insurance calculated amount that would affect the payable amount for this service (calculated from COB_Hold, COB_Mem_Resp, COB_Savings, and COB_Savings_Used). Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coB_Hold: type: number description: Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied. format: double nullable: true coB_Mem_Resp: type: number description: Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied. format: double nullable: true coB_Savings: type: number description: Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied. format: double nullable: true coB_Savings_Used: type: number description: Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied. format: double nullable: true calendar_Year: maxLength: 4 type: string description: Used for Flex Claims to indicate the calendar year this claim applies. nullable: true capitation_Claim: type: boolean description: 'Notes if this service line is captiated. If the Claim.Capitation_Claim value is flagged, it overrides this value and notes the entire claim and all service lines as capitated. Note: This field is marked as NOT NULL in the database and therefore required by the API.' check_ID: type: integer description: No longer in use. format: int32 nullable: true co_Ins_Amt: type: number description: 'The co-insurance amount applied by adjudication based on benefit definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double co_Pay_Amt: type: number description: 'The co-pay amount applied by adjudication based on benefit definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double currency_ID: maxLength: 16 type: string description: 'For currency calculations, this holds the destination currency.' nullable: true days_Supply: type: integer description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: int32 nullable: true ded_Credit_Amt: type: number description: 'If the service is eligiblity for deductible credits, they would be stored here.' format: double nullable: true deductible_Amt: type: number description: 'The deductible amount applied by adjudication based on benefit definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double detail_Plan_Year: maxLength: 8 type: string description: Indicates which Plan Year the service line correlates to from GroupPlanYear.Plan_Year nullable: true diagnosis_Code: maxLength: 8 type: string description: The diagnosis pointer for this service line indicating which Diagnostic Codes from the Claim are applicable to this service. nullable: true discount_Amt: type: number description: 'The difference between Billed and Allowed is stored as the Discount Amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double dispense_As_Written: type: integer description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: int32 nullable: true distal: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' drug_Code: maxLength: 20 type: string description: For RX claims or medical claims that hold a drug code. References DrugCode.Drug_Code. nullable: true drug_Quantity: type: number description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: double nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true ex_Code2: maxLength: 6 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true ex_Code3: maxLength: 6 type: string description: A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code. nullable: true fica: type: number description: 'The FICA tax amount for disability claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double facial: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' federal_Amount_To_Tax: type: number description: 'Based on taxable amount and various configurations, this holds the Federal "To Tax" amount for disability claim.' format: double nullable: true federal_Tax: type: number description: 'The calculated Federal tax amount based on the "To Tax" amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double federal_Tax_Flat: type: number description: A flat federal tax amount applied in addition to the calculated tax amount. format: double nullable: true fill_Date: type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: date-time nullable: true flex_Description: maxLength: 128 type: string description: Manually entered description of this flex claim. nullable: true formulary_Indicator: maxLength: 1 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true incisal: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' interest: type: number description: 'If interest is calculated on a claim, it is stored here and applied to payable amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double labial: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' life_Benefit: maxLength: 10 type: string description: The Life Benefit to be applied for Life claims processing. nullable: true life_Benefit_Volume: type: number description: The Life Benefit calculated volume based on benefit definition. format: double nullable: true line_Control_Number: maxLength: 64 type: string description: Number added manually to claims and from 837 files and sent outbound on 835 files. nullable: true lingual: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' local_Tax: type: number description: 'If a locality tax is applicable it would be housed here. Note: The database will apply a default value of `0` for this field if a value is not provided.' format: double nullable: true mail_Order_Indicator: maxLength: 1 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true medicare_Amount_To_Tax: type: number description: 'Based on taxable amount and various configurations, this holds the Medicare "To Tax" amount for disability claim.' format: double nullable: true medicare_Tax: type: number description: The calculated Medicare tax amount based on the "To Tax" amount. format: double nullable: true mesial: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' modifier: maxLength: 8 type: string description: The modifier applied to this service. nullable: true modifier_2: maxLength: 8 type: string description: The modifier applied to this service. nullable: true modifier_3: maxLength: 8 type: string description: The modifier applied to this service. nullable: true modifier_4: maxLength: 8 type: string description: The modifier applied to this service. nullable: true not_Covered_Amt: type: number description: 'For not covered services, or partially not covered services, this reflects that deduction. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double occlusal: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' oral_Cavity_Designation_Code_1: maxLength: 3 type: string description: For dental claims this holds the oral cavity designation sent on the 837D. nullable: true oral_Cavity_Designation_Code_2: maxLength: 3 type: string description: For dental claims this holds the oral cavity designation sent on the 837D. nullable: true oral_Cavity_Designation_Code_3: maxLength: 3 type: string description: For dental claims this holds the oral cavity designation sent on the 837D. nullable: true oral_Cavity_Designation_Code_4: maxLength: 3 type: string description: For dental claims this holds the oral cavity designation sent on the 837D. nullable: true oral_Cavity_Designation_Code_5: maxLength: 3 type: string description: For dental claims this holds the oral cavity designation sent on the 837D. nullable: true other_Deduction_Amount: type: number description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: double nullable: true override_Benefit_Code: type: boolean description: 'This flag indicates if the benefit code has been overridden. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_COB_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Co_Ins_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Co_Pay_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Ded_Credit_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Deductible_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Federal_Tax: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Local_Tax: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Medicare_Tax: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Not_Covered_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Plan_Price: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Social_Security: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_State_Tax: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_With_Hold_Amt: type: boolean description: 'Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ppO_Price_Plan_Price_Diff: type: number description: Information field used in custom processing and reporting. format: double nullable: true paid_Amt: type: number description: 'The final paid amount for this service line based on allowed amount (Plan_Price) minus all applicable deductions. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double partial_Loss: type: number description: 'The partial loss amount for disability claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double payor_ID: maxLength: 20 type: string description: 'For reference purposes, this hold the individual service line funding payor/account. If multiple payor/accounts are found on different service lines for the same claim, adjudication spits out an error.' nullable: true pharmacy_Name: maxLength: 128 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true place_Of_Service: maxLength: 5 type: string description: The place of service for the services being rendered on this service line. nullable: true plan_Price: type: number description: 'The allowed amount for this service based on fee schedule, pricing, repricing, etc. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double premium_Deduction: type: number description: 'The premium deduction amount for disability claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double prescriber_ID: maxLength: 32 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true prescription_Date: type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: date-time nullable: true prescription_Number: maxLength: 50 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true pricing_Method: maxLength: 8 type: string description: 'For reprice claims (typically submitted via 837), this notes the reprice method used to reprice this service line.' nullable: true pricing_Rate: type: number description: The rate associated with the reprice method (Pricing_Method). format: double nullable: true principal: type: number description: 'For life claims, this holds the principal amount for reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double procedure_Code: maxLength: 8 type: string description: The service being rendered on this claim. nullable: true procedure_Code2: maxLength: 8 type: string description: The secondary service being rendered on this claim. nullable: true qualifying_Payment_Amount: type: number description: QPA (Qualified Payment Amount) values received in upcoming EDI transactions for the NSA (No Surprise Act) mandate. format: double nullable: true reason_Code: type: integer description: No longer in use. format: int32 nullable: true refill_Indicator: type: integer description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: int32 nullable: true repriced_Savings_Amount: type: number description: Holds the submitted reprice savings amount for services that include this amount in the pricing calculation. format: double nullable: true root: type: boolean description: 'For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' service_Date: type: string description: The start date of the services being rendered. format: date-time nullable: true service_Thru: type: string description: The end date of the services being rendered. format: date-time nullable: true socSec_Amount_To_Tax: type: number description: 'Based on taxable amount and various configurations, this holds the Social Security "To Tax" amount for disability claim.' format: double nullable: true social_Security: type: number description: 'The calculated Social Security tax amount based on the "To Tax" amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double state_Amount_To_Tax: type: number description: 'Based on taxable amount and various configurations, this holds the State "To Tax" amount for disability claim.' format: double nullable: true state_Tax: type: number description: 'The calculated State tax amount based on the "To Tax" amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double state_Tax_Flat: type: number description: A flat state tax amount applied in addition to the calculated tax amount. format: double nullable: true state_Tax_State: maxLength: 2 type: string description: 'When state taxes are calculated, this indicates the state the tax amount was calculated against.' nullable: true status_Code: maxLength: 1 type: string description: 'Holds the individaul status of this service line based on Ex Codes. A - Payable, D - Denied, E - Pended.' nullable: true svc_Count: type: number description: The units applied to this service. format: double nullable: true taxable_Amount: type: number description: This holds the starting taxable amount based on pre-tax and pre-gross deductions applied to this service. format: double nullable: true tooth_Number: type: integer description: 'For dental claims, this identifies the tooth, quadrant or arch being worked for this service.' format: int32 nullable: true ucR_Price: type: number description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double unit_Dose: type: integer description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. format: int32 nullable: true unit_Of_Measure: maxLength: 2 type: string description: Pharmacy claim information submitted via file submission and used in reporting and interfaces. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true with_Hold_Amt: type: number description: 'For plans that allow withhold, this amount is used to track that amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double additionalProperties: false ClaimDetailDeduction: required: - adjustment_Seq - batch_Claim - batch_Number - claim_Seq - deduction_Pct - deduction_Seq - pre_Gross - pre_Tax type: object properties: batch_Number: type: integer format: int32 batch_Claim: type: integer format: int32 claim_Seq: maxLength: 2 minLength: 1 type: string adjustment_Seq: maxLength: 3 minLength: 1 type: string deduction_Seq: type: integer format: int32 case_Number: maxLength: 64 type: string nullable: true deduction_Amount: type: number format: double nullable: true deduction_Applied: type: number format: double nullable: true deduction_Pct: type: boolean deduction_Type: maxLength: 8 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true pre_Gross: type: boolean pre_Tax: type: boolean update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimDetailDeductionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimDetailDeduction' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimDetailDeductionVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimDetailDeduction' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimDetailExCode: required: - adjustment_Seq - batch_Claim - batch_Number - claim_Seq - cleared - ex_Code type: object properties: batch_Number: type: integer format: int32 batch_Claim: type: integer format: int32 claim_Seq: maxLength: 2 minLength: 1 type: string adjustment_Seq: maxLength: 3 minLength: 1 type: string ex_Code: maxLength: 6 minLength: 1 type: string claimRule_Key: type: integer format: int32 nullable: true cleared: type: boolean comment: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true ex_Code_Source: maxLength: 16 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimDetailExCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimDetailExCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimDetailExCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimDetailExCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimDisability: required: - batch_Number - exceed_Max - include_Return_To_Work - include_Waiting_Period - include_Waiting_Period_In_Max - partial_Disability - plan_Type_LTD - rollup_Waiting_Period - salary_Cont_Paid - scd - sick_Time_Paid - vacation_Paid - waive_Waiting_Period type: object properties: batch_Number: type: integer format: int32 admit_Date: type: string format: date-time nullable: true apply_Extension: type: integer format: int32 nullable: true apply_Extension_Ex_Code: maxLength: 8 type: string nullable: true attended_Physician: type: string format: date-time nullable: true birth_Date: type: string format: date-time nullable: true closure_Effective_Date: type: string format: date-time nullable: true delivery_Date: type: string format: date-time nullable: true delivery_Type: maxLength: 1 type: string nullable: true dep_SSDI_End_Date: type: string format: date-time nullable: true description: maxLength: 512 type: string nullable: true diagnostic_Code1: maxLength: 8 type: string nullable: true diagnostic_Code2: maxLength: 8 type: string nullable: true diagnostic_Code_Type: maxLength: 16 type: string nullable: true disability_Pay_Through_Day: type: integer format: int32 nullable: true disability_Type: maxLength: 1 type: string nullable: true disabled_By_Physician: type: string format: date-time nullable: true discharge_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true ex_Code: maxLength: 8 type: string nullable: true exceed_Max: type: boolean exhaust_Date: type: string format: date-time nullable: true expected_Typical_Duration: type: integer format: int32 nullable: true ficA_Percent: type: number format: double nullable: true federal_Withheld: type: number format: double nullable: true followup_Date: type: string format: date-time nullable: true followup_Ex_Code: maxLength: 8 type: string nullable: true group_ID: maxLength: 20 type: string nullable: true image_Number_1: maxLength: 64 type: string nullable: true image_Number_2: maxLength: 64 type: string nullable: true image_Number_3: maxLength: 64 type: string nullable: true image_Number_4: maxLength: 64 type: string nullable: true include_Return_To_Work: type: boolean include_Waiting_Period: type: boolean include_Waiting_Period_In_Max: type: boolean job_Type: maxLength: 6 type: string nullable: true ltD_Effective_Date: type: string format: date-time nullable: true ltD_Packet_Date: type: string format: date-time nullable: true last_Day_Worked: type: string format: date-time nullable: true last_Physician_Warrant_Date: type: string format: date-time nullable: true liability_Injury: type: integer format: int32 nullable: true mail_To: maxLength: 1 type: string nullable: true max_Disability_Days: type: integer format: int32 nullable: true member_Seq: maxLength: 2 type: string nullable: true overpayment_Deduction: type: number format: double nullable: true overpayment_Ex_Code: maxLength: 8 type: string nullable: true overpayment_Total: type: number format: double nullable: true partial_Disability: type: boolean pay_To: maxLength: 1 type: string nullable: true payment_Days: type: integer format: int32 nullable: true payment_Duration: type: integer format: int32 nullable: true physician_Return_To_Work: type: string format: date-time nullable: true plan_ID: maxLength: 20 type: string nullable: true plan_Type: maxLength: 6 type: string nullable: true plan_Type_LTD: type: boolean received_Date: type: string format: date-time nullable: true return_To_Work: type: string format: date-time nullable: true rollup_Waiting_Period: type: boolean scd: type: boolean salary_Cont_Ex_Code: maxLength: 8 type: string nullable: true salary_Cont_From: type: string format: date-time nullable: true salary_Cont_Paid: type: boolean salary_Cont_Thru: type: string format: date-time nullable: true sick_Time_Ex_Code: maxLength: 8 type: string nullable: true sick_Time_From: type: string format: date-time nullable: true sick_Time_Paid: type: boolean sick_Time_Thru: type: string format: date-time nullable: true state_Withheld: type: number format: double nullable: true subscriber_ID: maxLength: 20 type: string nullable: true type_Of_Surgery: maxLength: 6 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true vacation_Ex_Code: maxLength: 8 type: string nullable: true vacation_From: type: string format: date-time nullable: true vacation_Paid: type: boolean vacation_Thru: type: string format: date-time nullable: true waiting_Period: type: integer format: int32 nullable: true waiting_Period_Ex_Code: maxLength: 8 type: string nullable: true waive_Waiting_Period: type: boolean additionalProperties: false ClaimDisabilityDeduction: required: - batch_Number - deduction_Pct - pre_Gross - pre_Tax - third_Party_Payment type: object properties: batch_Number: type: integer format: int32 case_Number: maxLength: 64 type: string nullable: true deduction_Amount: type: number format: double nullable: true deduction_Pct: type: boolean deduction_Type: maxLength: 8 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true pre_Gross: type: boolean pre_Tax: type: boolean provider_ID: maxLength: 20 type: string nullable: true third_Party_Payment: type: boolean update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimDisabilityDeductionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimDisabilityDeduction' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimDisabilityDeductionVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimDisabilityDeduction' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimDisabilityListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimDisability' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimDisabilityVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimDisability' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimExCode: required: - batch_Claim - batch_Number - cleared - ex_Code type: object properties: batch_Number: type: integer format: int32 batch_Claim: type: integer format: int32 ex_Code: maxLength: 6 minLength: 1 type: string claimRule_Key: type: integer format: int32 nullable: true cleared: type: boolean comment: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true ex_Code_Source: maxLength: 16 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimExCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimExCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimExCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimExCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimFlex: required: - auto_Created - batch_Number - calendar_Year - claimFlex_Key - diagnostic_Code_Type - effective_Date - flex_Claim_Number - group_ID - plan_ID - subscriber_ID type: object properties: claimFlex_Key: type: integer format: int32 adjudicate_Action: maxLength: 8 type: string nullable: true amount: type: number format: double nullable: true auto_Created: type: boolean auto_Created_Claim_Number: type: integer format: int32 nullable: true auto_Created_Date: type: string format: date-time nullable: true batch_Number: type: integer format: int32 calendar_Year: maxLength: 4 minLength: 1 type: string diagnostic_Code1: maxLength: 8 type: string nullable: true diagnostic_Code2: maxLength: 8 type: string nullable: true diagnostic_Code3: maxLength: 8 type: string nullable: true diagnostic_Code4: maxLength: 8 type: string nullable: true diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string effective_Date: type: string format: date-time entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true ex_Code: maxLength: 6 type: string nullable: true flex_Claim_Number: maxLength: 64 minLength: 1 type: string flex_Claim_Status: maxLength: 16 type: string nullable: true group_ID: maxLength: 20 minLength: 1 type: string member_Birth_Date: type: string format: date-time nullable: true member_First_Name: maxLength: 32 type: string nullable: true member_Last_Name: maxLength: 32 type: string nullable: true plan_ID: maxLength: 20 minLength: 1 type: string provider_Federal_ID: maxLength: 20 type: string nullable: true provider_ID: maxLength: 20 type: string nullable: true provider_Name: maxLength: 128 type: string nullable: true received_Date: type: string format: date-time nullable: true send_Check_To: maxLength: 1 type: string nullable: true service_Date: type: string format: date-time nullable: true service_Thru: type: string format: date-time nullable: true subscriber_ID: maxLength: 9 minLength: 1 type: string update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimFlexDetail: required: - batch_Claim - batch_Number - claimFlex_Key type: object properties: claimFlex_Key: type: integer format: int32 batch_Number: type: integer format: int32 batch_Claim: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimFlexDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimFlexDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimFlexDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimFlexDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimFlexListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimFlex' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimFlexService: required: - claimFlex_Key - claimFlexService_Key type: object properties: claimFlexService_Key: type: integer format: int32 amount: type: number format: double nullable: true claimFlex_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true ex_Code: maxLength: 6 type: string nullable: true flex_Description: maxLength: 128 type: string nullable: true mcc: maxLength: 4 type: string nullable: true matching_Transaction_ID: maxLength: 10 type: string nullable: true merchant_Name: maxLength: 50 type: string nullable: true payment_Reference: maxLength: 25 type: string nullable: true place_Of_Service: maxLength: 4 type: string nullable: true procedure_Code: maxLength: 8 type: string nullable: true service_Date: type: string format: date-time nullable: true service_Thru: type: string format: date-time nullable: true transaction_Code: maxLength: 8 type: string nullable: true transaction_Source: maxLength: 4 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimFlexServiceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimFlexService' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimFlexServiceVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimFlexService' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimFlexVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimFlex' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimFundedStatus: required: - claim_Funded_Status type: object properties: claim_Funded_Status: maxLength: 32 minLength: 1 type: string description: maxLength: 64 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimFundedStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimFundedStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimFundedStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimFundedStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoice: required: - invoice_Key type: object properties: invoice_Key: type: integer description: 'Invoice Identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: type: string description: Description for the Invoice nullable: true due_Date: type: string description: Due Date of the Invoice format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true invoice_Date: type: string description: Invoice Date for the Invoice format: date-time nullable: true invoice_Number: maxLength: 32 type: string description: Unique identifier Invoice Number nullable: true invoice_Status: maxLength: 16 type: string description: Status of the Invoice nullable: true payee_ID: maxLength: 20 type: string description: Payee of the Invoice nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ClaimInvoiceAdjustment: required: - claimInvoiceAdjustment_Key - invoice_Key type: object properties: claimInvoiceAdjustment_Key: type: integer description: 'Unique Claim Invoice Adjustment identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 adjustment_Amount: type: number description: Amount of the Claim Invoice Adjustment format: double nullable: true adjustment_Date: type: string description: Date the Claim Invoice Adjustment format: date-time nullable: true adjustment_Reason: type: integer description: Reason of the Claim Invoice Adjustment format: int32 nullable: true batch_Claim: type: integer description: Claim Batch Claim Identifier format: int32 nullable: true batch_Number: type: integer description: Claim Batch Number Identifier format: int32 nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true invoice_Key: type: integer description: 'Invoice Identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ClaimInvoiceAdjustmentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimInvoiceAdjustment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoiceAdjustmentReason: required: - adjustment_Reason - description type: object properties: adjustment_Reason: type: integer description: 'Unique identifier for the Adjustment_Reason Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: minLength: 1 type: string description: Description of the Reason entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ClaimInvoiceAdjustmentReasonListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReason' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoiceAdjustmentReasonVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReason' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoiceAdjustmentReceived: required: - claimInvoiceAdjustment_Key - claimInvoiceAdjustmentReceived_Key - claimPayment_Key type: object properties: claimInvoiceAdjustmentReceived_Key: type: integer description: 'Unique Claim Invoice Adjustment Received identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 adjustment_Received: type: number description: Amount of the Claim Invoice Adjustment Received format: double nullable: true adjustment_Received_Date: type: string description: Date the Claim Invoice Adjustment Received format: date-time nullable: true claimInvoiceAdjustment_Key: type: integer description: 'Unique Claim Invoice Adjustment identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 claimPayment_Key: type: integer description: 'Unique Payment identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ClaimInvoiceAdjustmentReceivedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceived' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoiceAdjustmentReceivedVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimInvoiceAdjustmentReceived' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoiceAdjustmentVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimInvoiceAdjustment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoiceConfig: type: object properties: claimInvoice: $ref: '#/components/schemas/ClaimInvoice' claimNumbers: type: array items: type: integer format: int32 nullable: true additionalProperties: false ClaimInvoiceDetail: required: - batch_Claim - batch_Number - invoice_Key type: object properties: invoice_Key: type: integer description: 'Invoice the claim is on Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 batch_Number: type: integer description: 'Unique identifier for the Batch Number Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 batch_Claim: type: integer description: 'Unique identifier for the Batch Claim Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ClaimInvoiceDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimInvoiceDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoiceDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimInvoiceDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoiceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimInvoice' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoicePayment: required: - claimPayment_Key - invoice_Key type: object properties: invoice_Key: type: integer description: 'Invoice Identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 claimPayment_Key: type: integer description: 'Unique Payment identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true payment_Posted: type: number description: Invoice Payment Amount Applied format: double nullable: true payment_Posted_Date: type: string description: Date of Payment applied format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ClaimInvoicePaymentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimInvoicePayment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoicePaymentVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimInvoicePayment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoiceReceived: required: - claimInvoiceReceived_Key - claimPayment_Key - invoice_Key type: object properties: claimInvoiceReceived_Key: type: integer description: 'Unique Claim Invoice Received identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 claimPayment_Key: type: integer description: 'Unique Payment identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true invoice_Key: type: integer description: 'Invoice Identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 received_Amount: type: number description: Amount of the Payment Received format: double nullable: true received_Date: type: string description: Date the Payment Received format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ClaimInvoiceReceivedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimInvoiceReceived' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoiceReceivedVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimInvoiceReceived' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimInvoiceVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimInvoice' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimOccurrenceCode: required: - occurrence_Code type: object properties: occurrence_Code: maxLength: 8 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimOccurrenceCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimOccurrenceCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimOccurrenceCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimOccurrenceCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimPayment: required: - claimPayment_Key type: object properties: claimPayment_Key: type: integer description: 'Unique Payment identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 account_Key: type: integer description: Account of the Payment format: int32 nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true funding_Key: type: integer description: Funding record of the Payment format: int32 nullable: true payment_Amount: type: number description: Amount of the Payment format: double nullable: true payment_Date: type: string description: Date of the Payment format: date-time nullable: true payment_Name: maxLength: 256 type: string description: Name of the Payment nullable: true payment_Type: maxLength: 32 type: string description: Type of the Payment nullable: true payor_ID: maxLength: 20 type: string description: Unique identifier for the Payor nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ClaimPaymentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimPayment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimPaymentVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimPayment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimPreBatch: required: - advance_Pay - advice_To_Pay - aeoB_Claim - batch_Claim - batch_Number - calculate_Interest - capitation_Claim - claimPreBatch_Key - liability_Injury - occupational - orthodontics_Treatment - other_Insurance - partial_Disability - patient_Signature - prosthesis_Replacement - related_To_Accident - related_To_Another_Party - related_To_Auto - related_To_Employment - salary_Continuation - sick_Time - subscriber_Signature - survivor_Benefit - third_Party_Payment - total_COB - transaction_837 - vacation - volume_Override - waiting_Period_Claim type: object properties: claimPreBatch_Key: type: integer description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 aeoB_Claim: type: boolean description: 'A flag indicating a claim is an Advanced EOB and not a claim for payment. Part of the No Surprise Act. Note: This field is marked as NOT NULL in the database and therefore required by the API.' accident_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true account_Key: type: integer description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: int32 nullable: true adjusted_From: type: integer description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: int32 nullable: true admission_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true admission_Diagnostic_Code: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true admission_Hour: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true admission_Source: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true admit_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true advance_Pay: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' advice_To_Pay: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' all_Docs_Rec_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true ambulance_DropOff_Address: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ambulance_DropOff_Address2: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ambulance_DropOff_City: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ambulance_DropOff_Location: maxLength: 64 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ambulance_DropOff_Org_Name: maxLength: 512 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ambulance_DropOff_State: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ambulance_DropOff_Zip: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ambulance_PickUp_Address: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ambulance_PickUp_Address2: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ambulance_PickUp_City: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ambulance_PickUp_Location: maxLength: 64 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ambulance_PickUp_State: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ambulance_PickUp_Zip: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true appliance_Placed_Date: type: string description: The date the orthodontic appliance was placed. format: date-time nullable: true assumed_Care_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true attend_Provider_Address: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true attend_Provider_Address2: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true attend_Provider_City: maxLength: 30 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true attend_Provider_Federal_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true attend_Provider_First_Name: maxLength: 25 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true attend_Provider_Last_Name: maxLength: 35 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true attend_Provider_MAID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true attend_Provider_NPI: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true attend_Provider_Org_Name: maxLength: 512 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true attend_Provider_Phone: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true attend_Provider_State: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true attend_Provider_Taxonomy: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true attend_Provider_Zip: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true attended_Physician_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true batch_Claim: type: integer description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 batch_Number: type: integer description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 beneficiary_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true bill_Provider_Address: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true bill_Provider_Address2: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true bill_Provider_City: maxLength: 30 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true bill_Provider_Federal_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true bill_Provider_First_Name: maxLength: 25 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true bill_Provider_Last_Name: maxLength: 35 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true bill_Provider_MAID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true bill_Provider_NPI: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true bill_Provider_Org_Name: maxLength: 512 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true bill_Provider_Phone: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true bill_Provider_State: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true bill_Provider_Taxonomy: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true bill_Provider_Zip: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true billed_Amount: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true calculate_Interest: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' capitation_Claim: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' claim_837_COB: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true claim_ID: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true claim_Priority: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true claim_Status: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true claim_Type: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true closure_Effective_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true condition_Code1: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true condition_Code10: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code11: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code12: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code13: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code14: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code15: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code16: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code17: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code18: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code19: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code2: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true condition_Code20: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code21: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code22: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code23: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code24: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code3: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true condition_Code4: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true condition_Code5: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true condition_Code6: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true condition_Code7: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true condition_Code8: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true condition_Code9: maxLength: 8 type: string description: The Condition Code value for this claim. nullable: true coverage_Start: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true current_Illness_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true drG_Code: maxLength: 4 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true drG_Quantity: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true death_Cert_Rec_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true delivery_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true delivery_Type: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true dep_SSDI_End_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true diagnostic_Code1: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code10: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code11: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code12: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code13: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code14: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code15: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code16: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code17: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code18: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code19: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code2: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code20: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code21: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code22: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code23: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code24: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code3: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code4: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code5: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code6: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code7: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code8: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true diagnostic_Code9: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true disability_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true disability_End_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true disability_Type: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true disabled_By_Physician: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true discharge_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true discharge_Hour: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true division_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true eCode_Diagnostic_Code: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true eCode_Diagnostic_Code10: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true eCode_Diagnostic_Code11: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true eCode_Diagnostic_Code12: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true eCode_Diagnostic_Code2: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true eCode_Diagnostic_Code3: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true eCode_Diagnostic_Code4: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true eCode_Diagnostic_Code5: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true eCode_Diagnostic_Code6: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true eCode_Diagnostic_Code7: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true eCode_Diagnostic_Code8: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true eCode_Diagnostic_Code9: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true epsdT_Condition_Indicator1: maxLength: 3 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true epsdT_Condition_Indicator2: maxLength: 3 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true epsdT_Condition_Indicator3: maxLength: 3 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true epsdT_Referral_Given: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true entry_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time entry_User: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true error_Beneficiary: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ex_Code1: maxLength: 6 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ex_Code2: maxLength: 6 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ex_Code3: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ex_Code4: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true exhaust_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true expected_Typical_Duration: type: integer description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: int32 nullable: true ficA_Percent: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true federal_Withheld: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true filing_Indicator: maxLength: 2 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true followUp_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true followUp_Ex_Code: maxLength: 6 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true freq_Code: maxLength: 8 type: string description: Medicare Resubmission code for the claim. Indicated in Box 22 of the claim report. nullable: true group_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true hearing_Vision_RX_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true image_File_Location: maxLength: 128 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true image_File_Location2: maxLength: 128 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true image_File_Location3: maxLength: 128 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true image_File_Location4: maxLength: 128 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true initial_Treatment_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true insured_Address: maxLength: 128 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true insured_Address2: maxLength: 128 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true insured_Alternate_ID: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true insured_Birth_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true insured_City: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true insured_Employer_ID: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true insured_First_Name: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true insured_ID: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true insured_Last_Name: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true insured_Phone: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true insured_Policy_Number: maxLength: 64 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true insured_SSN: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true insured_Sex: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true insured_State: maxLength: 64 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true insured_Zip: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true job_Type: maxLength: 2 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ltD_Effective_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true ltD_Packet_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true last_Day_Worked: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true last_Physician_Warrant_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true last_Seen_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true liability_Injury: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' mail_To: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true member_Seq: maxLength: 2 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true months_Of_Treatment: type: integer description: The number of months the orthodontic treatment will be. format: int32 nullable: true network_ID: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true occupational: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' occurrence_Code1: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true occurrence_Code10: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code11: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code12: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code13: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code14: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code15: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code16: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code17: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code18: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code19: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code2: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true occurrence_Code20: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code21: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code22: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code23: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code24: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code3: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true occurrence_Code4: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true occurrence_Code5: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code6: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code7: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code8: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Code9: maxLength: 8 type: string description: The Occurrence Code value for this claim. nullable: true occurrence_Date1: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true occurrence_Date10: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date11: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date12: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date13: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date14: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date15: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date16: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date17: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date18: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date19: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date2: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true occurrence_Date20: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date21: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date22: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date23: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date24: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date3: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true occurrence_Date4: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true occurrence_Date5: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date6: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date7: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date8: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Date9: type: string description: The Occurrence Date associated to the assigned Occurrence Codes. format: date-time nullable: true occurrence_Span_Code: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true occurrence_Span_Code10: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code11: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code12: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code13: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code14: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code15: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code16: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code17: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code18: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code19: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code2: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code20: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code21: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code22: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code23: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code24: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code3: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code4: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code5: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code6: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code7: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code8: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_Code9: maxLength: 8 type: string description: The occurrence span indicator for the Occurrence Span From and Thru dates. nullable: true occurrence_Span_From: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true occurrence_Span_From10: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From11: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From12: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From13: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From14: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From15: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From16: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From17: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From18: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From19: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From2: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From20: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From21: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From22: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From23: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From24: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From3: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From4: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From5: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From6: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From7: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From8: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_From9: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true occurrence_Span_Thru10: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru11: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru12: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru13: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru14: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru15: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru16: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru17: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru18: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru19: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru2: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru20: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru21: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru22: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru23: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru24: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru3: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru4: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru5: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru6: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru7: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru8: type: string description: The occurrence span from for this claim. format: date-time nullable: true occurrence_Span_Thru9: type: string description: The occurrence span from for this claim. format: date-time nullable: true onset_Similar_Illness_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true oper_Provider_Address: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oper_Provider_Address2: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oper_Provider_City: maxLength: 30 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oper_Provider_Federal_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oper_Provider_First_Name: maxLength: 25 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oper_Provider_Last_Name: maxLength: 35 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oper_Provider_MAID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oper_Provider_NPI: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oper_Provider_Org_Name: maxLength: 512 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oper_Provider_Phone: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oper_Provider_State: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oper_Provider_Taxonomy: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oper_Provider_Zip: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true orthodontics_Treatment: type: boolean description: 'This flag indicates the dental claim is for orthodontics. Note: This field is marked as NOT NULL in the database and therefore required by the API.' other_Insurance: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' other_Procedure_Code1: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code10: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code11: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code12: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code13: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code14: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code15: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code16: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code17: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code18: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code19: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code2: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code20: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code21: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code22: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code23: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code3: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code4: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code5: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code6: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code7: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code8: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Code9: maxLength: 8 type: string description: Additional procedure code (ICD10 Diagnosis) values for this claim submission. nullable: true other_Procedure_Date1: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date10: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date11: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date12: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date13: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date14: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date15: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date16: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date17: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date18: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date19: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date2: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date20: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date21: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date22: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date23: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date3: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date4: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date5: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date6: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date7: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date8: type: string description: Date associated with the additional procedure code. format: date-time nullable: true other_Procedure_Date9: type: string description: Date associated with the additional procedure code. format: date-time nullable: true partial_Disability: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' patient_Account: maxLength: 128 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_Address: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_Address2: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_Birth_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true patient_City: maxLength: 30 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_First_Name: maxLength: 25 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_ID: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_Last_Name: maxLength: 35 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_Phone: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_Reason_for_Visit_Diagnostic_Code1: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_Reason_for_Visit_Diagnostic_Code2: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_Reason_for_Visit_Diagnostic_Code3: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_Relationship: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_Sex: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_Signature: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' patient_Signature_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true patient_State: maxLength: 50 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_Status: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true patient_Zip: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payToPlan_Address: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payToPlan_Address2: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payToPlan_City: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payToPlan_Claim_Office_Num: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payToPlan_ID: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payToPlan_NAIC: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payToPlan_Name: maxLength: 512 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payToPlan_State: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payToPlan_Zip: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payTo_Address: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payTo_Address2: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payTo_City: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payTo_State: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payTo_Zip: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payee_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true payor_Claim_Control_Number: maxLength: 64 type: string description: A claim reference number used in conjunction with the Medicare Resubmission code. Indicated in Box 22 of the claim report. nullable: true payor_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true physician_Return_To_Work: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true place_Of_Service: maxLength: 5 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true plan_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true plan_Provider: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true plan_Year: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission1: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission10: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission11: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission12: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission13: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission14: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission15: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission16: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission17: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission18: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission19: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission2: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission20: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission21: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission22: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission23: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission24: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission3: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission4: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission5: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission6: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission7: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission8: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission9: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission_ECode1: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission_ECode10: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission_ECode11: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission_ECode12: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission_ECode2: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission_ECode3: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission_ECode4: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission_ECode5: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission_ECode6: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission_ECode7: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission_ECode8: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true present_On_Admission_ECode9: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true pricing_Org_ID: maxLength: 50 type: string description: The ID of the pricing organization. Data is obtained in segment HCP04 on an 837. nullable: true principal_Procedure_Code: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true principal_Procedure_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true prior_Placement_Date: type: string description: 'The date of a previous prosthetic or crown applied, if there was one.' format: date-time nullable: true prosthesis_Replacement: type: boolean description: 'This flag indicates if this claim is for the replacement of a prosthesis. Note: This field is marked as NOT NULL in the database and therefore required by the API.' provider_Address: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true provider_Address2: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true provider_City: maxLength: 30 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true provider_Federal_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true provider_First_Name: maxLength: 30 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true provider_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true provider_Last_Name: maxLength: 30 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true provider_MAID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true provider_NPI: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true provider_Org_Name: maxLength: 512 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true provider_Phone: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true provider_State: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true provider_Taxonomy: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true provider_Zip: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true received_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true ref_Provider_Address: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ref_Provider_Address2: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ref_Provider_City: maxLength: 30 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ref_Provider_Federal_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ref_Provider_First_Name: maxLength: 25 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ref_Provider_Last_Name: maxLength: 35 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ref_Provider_MAID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ref_Provider_NPI: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ref_Provider_Org_Name: maxLength: 512 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ref_Provider_Phone: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ref_Provider_State: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ref_Provider_Taxonomy: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ref_Provider_Zip: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true referred_By: maxLength: 30 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true refund_Check_ID: type: integer description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: int32 nullable: true refund_Funding_Key: type: integer description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: int32 nullable: true related_To_Accident: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' related_To_Another_Party: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' related_To_Auto: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' related_To_Employment: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' relinquished_Care_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true rend_Provider_Address: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true rend_Provider_Address2: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true rend_Provider_City: maxLength: 30 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true rend_Provider_Federal_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true rend_Provider_First_Name: maxLength: 25 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true rend_Provider_Last_Name: maxLength: 35 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true rend_Provider_MAID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true rend_Provider_NPI: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true rend_Provider_Org_Name: maxLength: 512 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true rend_Provider_Phone: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true rend_Provider_State: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true rend_Provider_Taxonomy: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true rend_Provider_Zip: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true repriced_Network_ID: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true return_To_Work_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true salary_Continuation: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' send_Check_To: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true sender_ID: maxLength: 15 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true service_Fac_Loc_Address: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Fac_Loc_Address2: maxLength: 90 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Fac_Loc_City: maxLength: 30 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Fac_Loc_Federal_ID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Fac_Loc_First_Name: maxLength: 25 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Fac_Loc_Last_Name: maxLength: 35 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Fac_Loc_MAID: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Fac_Loc_NPI: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Fac_Loc_Org_Name: maxLength: 512 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Fac_Loc_Phone: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Fac_Loc_State: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Fac_Loc_Taxonomy: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Fac_Loc_Zip: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true service_Thru: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true sick_Time: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' subscriber_ID: maxLength: 9 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true subscriber_Signature: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' survivor_Benefit: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' third_Party_Payment: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' total_COB: type: number description: 'COB total for all claim detail lines Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double trans_837_Control_Num: maxLength: 9 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true transaction_837: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' transaction_837_ID: maxLength: 30 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true type_Of_Admission: maxLength: 6 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true type_Of_Bill: maxLength: 6 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true update_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time update_User: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true vacation: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' value_Amount10: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount11: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount12: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount13: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount14: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount15: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount16: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount17: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount18: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount19: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount20: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount21: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount22: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount23: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount24: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount5: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount6: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount7: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount8: type: number description: The monetary amount related to the value code. format: double nullable: true value_Amount9: type: number description: The monetary amount related to the value code. format: double nullable: true value_Code10: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code11: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code12: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code13: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code14: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code15: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code16: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code17: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code18: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code19: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code20: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code21: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code22: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code23: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code24: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code5: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code6: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code7: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code8: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true value_Code9: maxLength: 2 type: string description: The code indicating a monetary condition which was used by the intermediary to process an institutional claim. nullable: true void_Check_ID: type: integer description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: int32 nullable: true volume_Override: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' waiting_Period_Claim: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false ClaimPreBatchDetail: required: - adjustment_Seq - batch_Claim - batch_Number - billed_Price - buccal - claim_Seq - claimPreBatchDetail_Key - co_Ins_Amt - co_Pay_Amt - coB_Amt - deductible_Amt - discount_Amt - distal - facial - federal_Tax - fica - incisal - interest - labial - lingual - mesial - not_Covered_Amt - occlusal - paid_Amt - partial_Loss - plan_Price - premium_Deduction - principal - root - social_Security - state_Tax - ucR_Price - with_Hold_Amt type: object properties: claimPreBatchDetail_Key: type: integer description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 ansI_Code: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true apC_Code: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true adjusted_From_Adjustment_Line: maxLength: 3 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true adjusted_From_Line: maxLength: 2 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true adjustment_Seq: maxLength: 3 minLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. auth_Number: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true auth_Required: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true batch_Claim: type: integer description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 batch_Number: type: integer description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 benefit_Code: maxLength: 10 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true benefit_Rate_Applied: type: number description: Benefit Rate being applied to this detail line. format: double nullable: true billed_Price: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double brand_Indicator: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true buccal: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' coB_Amt: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double coB_Hold: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true coB_Mem_Resp: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true claim_Seq: maxLength: 2 minLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. co_Ins_Amt: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double co_Pay_Amt: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double days_Supply: type: integer description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: int32 nullable: true deductible_Amt: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double diagnosis_Code: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true discount_Amt: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double dispense_As_Written: type: integer description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: int32 nullable: true distal: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' drug_Code: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true drug_Quantity: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true entry_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time entry_User: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ex_Code: maxLength: 6 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ex_Code2: maxLength: 6 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true ex_Code3: maxLength: 6 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true fica: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double facial: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' federal_Amount_To_Tax: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true federal_Tax: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double federal_Tax_Flat: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true fill_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true formulary_Indicator: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true incisal: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' interest: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double labial: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' line_Control_Number: maxLength: 64 type: string description: Number added manually to claims and from 837 files and sent outbound on 835 files. nullable: true lingual: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' local_Tax: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true mail_Order_Indicator: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true medicare_Amount_To_Tax: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true medicare_Tax: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true mesial: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' modifier: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true modifier_2: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true modifier_3: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true modifier_4: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true not_Covered_Amt: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double occlusal: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' oral_Cavity_Designation_Code_1: maxLength: 3 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oral_Cavity_Designation_Code_2: maxLength: 3 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oral_Cavity_Designation_Code_3: maxLength: 3 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oral_Cavity_Designation_Code_4: maxLength: 3 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true oral_Cavity_Designation_Code_5: maxLength: 3 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true other_Deduction_Amount: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true paid_Amt: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double partial_Loss: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double pharmacy_Name: maxLength: 128 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true place_Of_Service: maxLength: 5 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true plan_Price: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double premium_Deduction: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double prescriber_ID: maxLength: 32 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true prescription_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true prescription_Number: maxLength: 50 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true principal: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double procedure_Code: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true procedure_Code2: maxLength: 8 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true qualifying_Payment_Amount: type: number description: QPA (Qualified Payment Amount) values received in upcoming EDI transactions for the NSA (No Surprise Act) mandate. format: double nullable: true reason_Code: type: integer description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: int32 nullable: true refill_Indicator: type: integer description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: int32 nullable: true root: type: boolean description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' service_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true service_Thru: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time nullable: true socSec_Amount_To_Tax: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true social_Security: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double state_Amount_To_Tax: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true state_Tax: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double state_Tax_Flat: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true state_Tax_State: maxLength: 2 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true status_Code: maxLength: 1 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true svc_Count: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true taxable_Amount: type: number description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: double nullable: true tooth_Number: type: integer description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: int32 nullable: true ucR_Price: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double unit_Dose: type: integer description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: int32 nullable: true update_Date: type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. format: date-time update_User: maxLength: 20 type: string description: Archive storage table for tracking initial entry of Claim information. Not to be used externally. nullable: true with_Hold_Amt: type: number description: 'Archive storage table for tracking initial entry of Claim information. Not to be used externally. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double additionalProperties: false ClaimPreBatchDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimPreBatchDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimPreBatchDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimPreBatchDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimPreBatchListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimPreBatch' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimPreBatchVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimPreBatch' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimPromptPay: required: - claimPromptPay_Key type: object properties: claimPromptPay_Key: type: integer description: 'Unique identifer for each claim prompt pay entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 division_ID: maxLength: 20 type: string description: 'The patients (or Subscribers) enrollment information, references Subenrollment.Division_ID.' nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 200 type: string description: User that first added the record to the system nullable: true group_ID: maxLength: 20 type: string description: 'The patients (or Subscribers) enrollment information, references Subenrollment.Group_ID.' nullable: true plan_ID: maxLength: 20 type: string description: Holds the plan the patient is enrolled in and that benefits are assigned. nullable: true prompt_Pay_Duration: type: integer description: 'Holds the length of the duration to define this prompt pay record, as a numeric value only.' format: int32 nullable: true prompt_Pay_Duration_Type: maxLength: 16 type: string description: 'Defines the type of duration used in configuration. D = Day, M = Month, Y = Year.' nullable: true tax_ID: maxLength: 32 type: string description: Holds the Tax_ID (Federal_ID) of the provider for this record. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ClaimPromptPayListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimPromptPay' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimPromptPayVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimPromptPay' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueue: required: - claimQueue_Key type: object properties: claimQueue_Key: type: integer description: 'Unique identifer for each claim queue entry. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true queue_Date: type: string description: The date this queue was created. format: date-time nullable: true queue_End: type: string description: This notes the end adjudication time of the last claim in this queue. format: date-time nullable: true queue_Priority: type: integer description: A priority identifying when a claim is picked up from the processor queue. format: int32 nullable: true queue_Start: type: string description: This notes the time the first claim in this queue is picked up. format: date-time nullable: true queue_Status: maxLength: 32 type: string description: 'The status of the queue: QUEUED - the claims are actively being worked, or COMPLETE - all claims have completed their processing.' nullable: true queue_Type: maxLength: 32 type: string description: 'The type of queue being created: CHECK - adjudicate the claims or PROCESS - process the claims.' nullable: true queue_User: maxLength: 20 type: string description: The user who created this queue. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ClaimQueueDetail: required: - batch_Claim - batch_Number - claimQueue_Key - claimQueueProcessor_Key type: object properties: claimQueue_Key: type: integer format: int32 batch_Number: type: integer format: int32 batch_Claim: type: integer format: int32 claimQueueProcessor_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true queue_Result: maxLength: 32 type: string nullable: true queue_Result_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimQueueDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimQueueDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimQueueDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimQueue' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueLog: required: - batch_Claim - batch_Number - claimQueueLog_Key - claimQueueProcessor_Key - sharedObject_ID type: object properties: claimQueueLog_Key: type: integer format: int32 batch_Claim: type: integer format: int32 batch_Number: type: integer format: int32 claimQueueProcessor_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true log_Action: maxLength: 256 type: string nullable: true log_Date: type: string format: date-time nullable: true log_Message: maxLength: 4000 type: string nullable: true log_Result: maxLength: 256 type: string nullable: true sharedObject_ID: type: integer format: int32 update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimQueueLogListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimQueueLog' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueLogVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimQueueLog' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueNotifyGroup: required: - claimQueue_Key - userGroup_Key type: object properties: claimQueue_Key: type: integer format: int32 userGroup_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimQueueNotifyGroupListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimQueueNotifyGroup' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueNotifyGroupVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimQueueNotifyGroup' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueNotifyUser: required: - claimQueue_Key - user_ID type: object properties: claimQueue_Key: type: integer format: int32 user_ID: maxLength: 20 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimQueueNotifyUserListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimQueueNotifyUser' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueNotifyUserVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimQueueNotifyUser' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueuePriority: required: - queue_Priority type: object properties: queue_Priority: type: integer format: int32 description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 200 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimQueuePriorityListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimQueuePriority' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueuePriorityVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimQueuePriority' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueProcessTrack: required: - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string process_In_Flight_Count: type: integer format: int32 nullable: true process_Status: maxLength: 32 type: string nullable: true additionalProperties: false ClaimQueueProcessTrackListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimQueueProcessTrack' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueProcessTrackVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimQueueProcessTrack' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueProcessor: required: - claimQueueProcessor_Key type: object properties: claimQueueProcessor_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true processor_Batch_Claim: type: integer format: int32 nullable: true processor_Batch_Number: type: integer format: int32 nullable: true processor_Check_In: type: string format: date-time nullable: true processor_SO_Count: type: integer format: int32 nullable: true processor_Status: maxLength: 32 type: string nullable: true processor_Subscriber_ID: maxLength: 20 type: string nullable: true processor_Timer: type: integer format: int32 nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimQueueProcessorListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimQueueProcessor' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueProcessorVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimQueueProcessor' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueResult: required: - queue_Result type: object properties: queue_Result: maxLength: 32 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimQueueResultListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimQueueResult' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueResultVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimQueueResult' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueSchedule: required: - claimQueueSchedule_Key type: object properties: claimQueueSchedule_Key: type: integer format: int32 description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true queue_Event_ID: type: integer format: int32 nullable: true queue_SQL: maxLength: 4000 type: string nullable: true queue_Type: maxLength: 32 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimQueueScheduleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimQueueSchedule' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueScheduleNotifyGroup: required: - claimQueueSchedule_Key - userGroup_Key type: object properties: claimQueueSchedule_Key: type: integer format: int32 userGroup_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimQueueScheduleNotifyGroupListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroup' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueScheduleNotifyGroupVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimQueueScheduleNotifyGroup' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueScheduleNotifyUser: required: - claimQueueSchedule_Key - user_ID type: object properties: claimQueueSchedule_Key: type: integer format: int32 user_ID: maxLength: 20 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimQueueScheduleNotifyUserListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUser' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueScheduleNotifyUserVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimQueueScheduleNotifyUser' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueScheduleVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimQueueSchedule' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueStatus: required: - queue_Status type: object properties: queue_Status: maxLength: 32 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimQueueStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimQueueStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimQueueStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimQueueVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimQueue' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRepriceRemove: required: - claimRepriceRemove_Key - remove_Repriced_Network_ID type: object properties: claimRepriceRemove_Key: type: integer description: 'Unique identifer for each claim reprice remove entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 apply_Network_ID: maxLength: 10 type: string description: Notes the new Network that should be applied to this claim if the Reprice Remove values match the inbound claim information. nullable: true division_ID: maxLength: 20 type: string description: 'The patients (or Subscribers) enrollment information, references Subenrollment.Division_ID.' nullable: true effective_Date: type: string description: Date when the reprice remove code becomes/became effective. format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 200 type: string description: User that first added the record to the system nullable: true ex_Code: maxLength: 6 type: string description: The ExCode applied to this claim reprice entry. nullable: true group_ID: maxLength: 20 type: string description: 'The patients (or Subscribers) enrollment information, references Subenrollment.Group_ID.' nullable: true remove_Repriced_Network_ID: type: boolean description: 'Notes if the Repriced_Network_ID value should be cleared as part of the Reprice Remove adjudication process. Note: This field is marked as NOT NULL in the database and therefore required by the API.' repriced_Network_ID: maxLength: 32 type: string description: The Repriced Network ID referenced on this claim to determine if rules apply. nullable: true tax_ID: maxLength: 32 type: string description: The Provider Tax ID referenced on this claim to determine if rules apply. nullable: true term_Date: type: string description: Date when the reprice remove code no longer applies. format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ClaimRepriceRemoveListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimRepriceRemove' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRepriceRemoveVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimRepriceRemove' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRule: required: - claimRule_Key - debug - process_If_Error - process_If_Override - required - system_Rule type: object properties: claimRule_Key: type: integer format: int32 claimRule_Object: maxLength: 64 type: string nullable: true claimRule_Result: maxLength: 1 type: string nullable: true debug: type: boolean description: maxLength: 512 type: string nullable: true display: maxLength: 64 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true error_Code: maxLength: 8 type: string nullable: true error_Type: maxLength: 32 type: string nullable: true ex_Code: maxLength: 6 type: string nullable: true process_If_Error: type: boolean process_If_Override: type: boolean required: type: boolean system_Rule: type: boolean update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimRuleClaimType: required: - claim_Type - claimRule_Key type: object properties: claimRule_Key: type: integer format: int32 claim_Type: maxLength: 20 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimRuleClaimTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimRuleClaimType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRuleClaimTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimRuleClaimType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRuleDependent: required: - claimRule_Key - dependent_ClaimRule_Key type: object properties: claimRule_Key: type: integer format: int32 dependent_ClaimRule_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimRuleDependentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimRuleDependent' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRuleDependentVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimRuleDependent' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRuleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimRule' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRuleProcedure: required: - claimRule_Key - exclude - from_Procedure - thru_Procedure type: object properties: claimRule_Key: type: integer format: int32 from_Procedure: maxLength: 8 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true exclude: type: boolean thru_Procedure: maxLength: 8 minLength: 1 type: string update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimRuleProcedureListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimRuleProcedure' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRuleProcedureVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimRuleProcedure' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRuleProviderType: required: - claimRule_Key - exclude - provider_Type type: object properties: claimRule_Key: type: integer format: int32 provider_Type: maxLength: 10 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true exclude: type: boolean update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimRuleProviderTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimRuleProviderType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRuleProviderTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimRuleProviderType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRuleSetDetail: required: - claimRule_Key - claimRule_Sequence - claimRuleSetHeader_Key type: object properties: claimRuleSetHeader_Key: type: integer format: int32 claimRule_Key: type: integer format: int32 claimRule_Sequence: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimRuleSetDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimRuleSetDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRuleSetDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimRuleSetDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRuleSetHeader: required: - claimRuleSetHeader_Key type: object properties: claimRuleSetHeader_Key: type: integer format: int32 business_Object: maxLength: 64 type: string nullable: true description: maxLength: 128 type: string nullable: true display: maxLength: 64 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimRuleSetHeaderListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimRuleSetHeader' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRuleSetHeaderVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimRuleSetHeader' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimRuleVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimRule' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimStatus: required: - claim_Status type: object properties: claim_Status: maxLength: 8 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true status_Description: maxLength: 90 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimTransaction: required: - claimTransaction_Key - transaction_Date - transaction_User type: object properties: claimTransaction_Key: type: integer format: int32 batch_Claim: type: integer format: int32 batch_Number: type: integer format: int32 claim_Status_Category_Code: maxLength: 8 type: string nullable: true claim_Status_Code: maxLength: 8 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true transaction_Batch_Claim: type: integer format: int32 nullable: true transaction_Batch_Number: type: integer format: int32 nullable: true transaction_Claim_Status: maxLength: 8 type: string nullable: true transaction_Date: type: string format: date-time transaction_Type: maxLength: 32 type: string nullable: true transaction_User: maxLength: 20 minLength: 1 type: string update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimTransactionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimTransaction' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimTransactionVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimTransaction' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimType: required: - claim_Type type: object properties: claim_Type: maxLength: 20 minLength: 1 type: string description: Unique identifier for each claim type. This table is maintaned and managed by VBA and should not be manipulated. description: maxLength: 256 type: string description: The description of this Claim Type. nullable: true additionalProperties: false ClaimTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimVBAResponse: type: object properties: data: $ref: '#/components/schemas/Claim' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimValueCode: required: - value_Code type: object properties: value_Code: maxLength: 4 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ClaimValueCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimValueCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClaimValueCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ClaimValueCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Class: required: - class_Code type: object properties: class_Code: maxLength: 32 minLength: 1 type: string description: Name for the class code. description: maxLength: 512 type: string description: Description of the class code. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ClassListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Class' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ClassVBAResponse: type: object properties: data: $ref: '#/components/schemas/Class' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false College: required: - college_Key type: object properties: college_Key: type: integer format: int32 address: maxLength: 128 type: string nullable: true address2: maxLength: 128 type: string nullable: true city: maxLength: 32 type: string nullable: true college_Type: maxLength: 16 type: string nullable: true country_ID: maxLength: 8 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true fax: maxLength: 32 type: string nullable: true fax_Country_Code: maxLength: 8 type: string nullable: true name: maxLength: 128 type: string nullable: true phone: maxLength: 32 type: string nullable: true phone_Country_Code: maxLength: 8 type: string nullable: true state: maxLength: 2 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true zip_Code: maxLength: 32 type: string nullable: true additionalProperties: false CollegeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/College' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CollegeType: required: - college_Type type: object properties: college_Type: maxLength: 16 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CollegeTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CollegeType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CollegeTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CollegeType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CollegeVBAResponse: type: object properties: data: $ref: '#/components/schemas/College' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Commission: required: - commission_Key type: object properties: commission_Key: type: integer description: 'Unique identifier for the Commission table Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 account_Key: type: integer description: Unique identifier for the Account format: int32 nullable: true adjustment_Amount: type: number description: Adjustment Amounts to this Commission format: double nullable: true adjustment_Amount_Received: type: number description: Adjustment Amounts Received to this Commission format: double nullable: true calculated_Commission_Amount: type: number description: Commission Amount after previous amounts format: double nullable: true calculated_Premium_Amount: type: number description: Premium Amount after previous amounts format: double nullable: true calculated_Premium_Amount_Received: type: number description: Premium Amount Received after previous amounts format: double nullable: true check_Batch: type: integer description: Check Batch for this Commission format: int32 nullable: true check_ID: type: integer description: Check for this Commission format: int32 nullable: true comm_Rate: type: number description: Decimal value that defines the base rate format: double nullable: true comm_Rate_Max: type: number description: Maximum the rate will be regardless of the calculation format: double nullable: true comm_Rate_Min: type: number description: Minimum the rate will be regardless of the calculation format: double nullable: true comm_Rate_Variable1: type: number description: First variable used in calculating the rate based on the type format: double nullable: true comm_Rate_Variable2: type: number description: Second variable used in calculating the rate based on the type format: double nullable: true comm_Rate_Variable3: type: number description: Third variable used in calculating the rate based on the type format: double nullable: true comm_Scale_From: type: number description: Beginning range of the amount used for scaling format: double nullable: true comm_Scale_Thru: type: number description: Ending range of the amount used for scaling format: double nullable: true comm_Scale_Timeframe: maxLength: 16 type: string description: Used to detemine what date to begin the range for scaling nullable: true comm_Scale_Type: maxLength: 16 type: string description: Determines what amount the scale is based off of nullable: true comm_Term_Range_From: type: integer description: 'Beginning range of a number of Days, Months, or Years' format: int32 nullable: true comm_Term_Range_Thru: type: integer description: 'Ending range of a number of Days, Months, or Years' format: int32 nullable: true comm_Term_Range_Type: maxLength: 1 type: string description: 'Determines if Term Range is Days, Months, or Years' nullable: true commissionAgencyRepRate_Key: type: integer description: Unique identifier for the CommissionAgencyRepRate table format: int32 nullable: true commissionAgencyRep_Key: type: integer format: int32 nullable: true commissionRate_Key: type: integer format: int32 nullable: true commissionTransaction_Key: type: integer description: Unique identifier for the CommissionTransaction table format: int32 nullable: true commission_Amount: type: number description: Full Commission Amount without adjusting for previous amounts format: double nullable: true commission_Basis: maxLength: 8 type: string description: Basis of the Commission nullable: true commission_Cycle: maxLength: 8 type: string description: Cycle of the Commission nullable: true commission_Date: type: string description: Date the Commission was calculated for format: date-time nullable: true dependent_Count: type: integer description: Number of Dependents used for this Commission format: int32 nullable: true division_ID: maxLength: 20 type: string description: Division for this Commission nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true group_ID: maxLength: 20 type: string description: Group for this Commission nullable: true invoiceAdjustment_Key: type: integer description: Unique identifier for the InvoiceAdjustment table format: int32 nullable: true invoice_Key: type: integer description: Unique identifier for the PremInvoice table format: int32 nullable: true license_Number: maxLength: 128 type: string description: Not used nullable: true license_State: maxLength: 2 type: string description: Not used nullable: true license_Type: maxLength: 32 type: string description: Not used nullable: true member_Count: type: integer description: Number of Members used for this Commission format: int32 nullable: true new_CommissionAgencyRep_Key: type: integer description: Not used format: int32 nullable: true original_CommissionAgencyRep_Key: type: integer description: Not used format: int32 nullable: true payor_ID: maxLength: 20 type: string description: Unique identifier for the Payor nullable: true plan_ID: maxLength: 20 type: string description: Plan for this Commission nullable: true premRate_Key: type: integer description: PremRate for this Commission format: int32 nullable: true premium_Amount: type: number description: Full Premium Amount without adjusting for previous amounts format: double nullable: true premium_Amount_Received: type: number description: Full Premium Amount Received without adjusting for previous amounts format: double nullable: true rep_Split: type: number description: The amount or percentage of the split format: double nullable: true rep_Split_Max: type: number description: Maximum amount of the split format: double nullable: true rep_Split_Min: type: number description: Minimum amount of the split format: double nullable: true rep_Split_Priority: type: integer description: Priority of the split format: int32 nullable: true rep_Split_Type: maxLength: 16 type: string description: Determines if split is percent or flat amount nullable: true subscriber_Count: type: integer description: Number of Subscribers used for this Commission format: int32 nullable: true subscriber_ID: maxLength: 20 type: string description: Subscriber for this Commission nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommissionActivity: required: - commissionActivity_Key type: object properties: commissionActivity_Key: type: integer description: 'Unique identifier for the CommissionActivity table Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 end_Date: type: string description: Date the activity was completed format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true machine_ID: maxLength: 128 type: string description: Unique identifier for the Machine nullable: true start_Date: type: string description: Date the activity began format: date-time nullable: true undo_Date: type: string description: Date activity was undone format: date-time nullable: true undo_User: maxLength: 20 type: string description: User who undid the activity nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true user_ID: maxLength: 16 type: string description: Unique identifier for the User nullable: true additionalProperties: false CommissionActivityListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionActivity' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionActivityVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionActivity' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAdjustment: required: - commissionAdjustment_Key - pre_Payment_Adjustment type: object properties: commissionAdjustment_Key: type: integer description: 'Unique identifier for the Commission Activity Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 account_Key: type: integer description: Account for this Commission Adjustment format: int32 nullable: true adjustment_Amount: type: number description: Amount of the adjustment format: double nullable: true adjustment_Date: type: string description: Date of the adjustment format: date-time nullable: true check_Batch: type: integer description: Check Batch for this Commission Adjustment format: int32 nullable: true check_ID: type: integer description: Check for this Commission Adjustment format: int32 nullable: true commissionAgencyRepRate_Key: type: integer description: Unique identifier for the CommissionAgencyRepRate table format: int32 nullable: true commissionTransaction_Key: type: integer description: Unique identifier for the CommissionTransaction table format: int32 nullable: true commission_Adjustment_Reason: maxLength: 8 type: string description: Reason for the Commission Adjustment nullable: true commission_Adjustment_Type: maxLength: 8 type: string description: Type of the Commission Adjustment nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true payor_ID: maxLength: 20 type: string description: Payor for this Commission Adjustment nullable: true pre_Payment_Adjustment: type: boolean description: 'TBD Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommissionAdjustmentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionAdjustment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAdjustmentReason: required: - commission_Adjustment_Reason type: object properties: commission_Adjustment_Reason: maxLength: 8 minLength: 1 type: string description: Unique identifier for the Commission Adjustment Reason description: maxLength: 64 type: string description: Description for the Commission Adjustment Reason nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommissionAdjustmentReasonListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionAdjustmentReason' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAdjustmentReasonVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionAdjustmentReason' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAdjustmentType: required: - commission_Adjustment_Type type: object properties: commission_Adjustment_Type: maxLength: 8 minLength: 1 type: string description: Unique identifier for the Commission Adjustment Type description: maxLength: 64 type: string description: Description for the Commission Adjustment Type nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommissionAdjustmentTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionAdjustmentType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAdjustmentTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionAdjustmentType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAdjustmentVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionAdjustment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAgency: required: - commissionAgency_Key type: object properties: commissionAgency_Key: type: integer description: 'Unique identifier for the Commission Agency table Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 address1: maxLength: 128 type: string description: Address1 of the Agency nullable: true address2: maxLength: 128 type: string description: Address2 of the Agency nullable: true agency_Type: maxLength: 32 type: string description: Type of the Agency nullable: true city: maxLength: 32 type: string description: City of the Agency nullable: true cluster_Hierarchy: maxLength: 32 type: string nullable: true country_ID: maxLength: 8 type: string description: Country ID of the Agency nullable: true county_Code: maxLength: 8 type: string description: County Code of the Agency nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true fax_Country_Code: maxLength: 8 type: string description: Fax Country Code of the Agency nullable: true fax_Number: maxLength: 32 type: string description: Fax Number of the Agency nullable: true name: maxLength: 128 type: string description: Name of the Agency nullable: true payee_ID: maxLength: 20 type: string description: Payee ID of the Agency nullable: true payment_Distribution_Interval: maxLength: 1 type: string description: Payment Distribution Interval of the Agency nullable: true phone_Country_Code: maxLength: 8 type: string description: Phone Country Code of the Agency nullable: true phone_Number: maxLength: 32 type: string description: Phone Number of the Agency nullable: true state: maxLength: 2 type: string description: State of the Agency nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true zip_Code: maxLength: 32 type: string description: Zip Code of the Agency nullable: true additionalProperties: false CommissionAgencyListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionAgency' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAgencyRep: required: - commissionAgency_Key - commissionAgencyRep_Key - commissionRep_Key type: object properties: commissionAgencyRep_Key: type: integer description: 'Unique identifier for the CommissionAgencyRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 agent_Number: maxLength: 32 type: string description: Unique identifier for the Agent nullable: true cluster_Level: maxLength: 32 type: string nullable: true commissionAgency_Key: type: integer description: 'Unique identifier for the CommissionAgency table Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 commissionRep_Key: type: integer description: 'Unique identifier for the CommissionRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 eO_Coverage_Deductible: type: number description: Informational format: double nullable: true eO_Coverage_End: type: string description: Informational format: date-time nullable: true eO_Coverage_Level: maxLength: 128 type: string description: Informational nullable: true eO_Coverage_Name: maxLength: 128 type: string description: Informational nullable: true eO_Coverage_Start: type: string description: Informational format: date-time nullable: true effective_Date: type: string description: Beginning date range the Agent represents the Agency format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true payee_ID: maxLength: 20 type: string description: Payee of the Agent nullable: true send_Check_To: maxLength: 2 type: string description: 'Determine if the Payee, Agnecy, or Agent is paid' nullable: true term_Date: type: string description: Ending date range the Agent represents the Agency format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommissionAgencyRepListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionAgencyRep' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAgencyRepRate: required: - commissionAgencyRep_Key - commissionAgencyRepRate_Key - commissionRate_Key type: object properties: commissionAgencyRepRate_Key: type: integer format: int32 commissionAgencyRep_Key: type: integer format: int32 commissionRate_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true parent_CommissionAgencyRepRate_Key: type: integer format: int32 nullable: true split: type: number format: double nullable: true split_Max: type: number format: double nullable: true split_Min: type: number format: double nullable: true split_Priority: type: integer format: int32 nullable: true split_Type: maxLength: 16 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CommissionAgencyRepRateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionAgencyRepRate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAgencyRepRateVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionAgencyRepRate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAgencyRepVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionAgencyRep' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAgencyType: required: - agency_Type type: object properties: agency_Type: maxLength: 32 minLength: 1 type: string description: Unique identifier for the Agency Type description: maxLength: 512 type: string description: Description of the Agency Type nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommissionAgencyTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionAgencyType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAgencyTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionAgencyType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAgencyVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionAgency' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAppointmentType: required: - appointment_Type type: object properties: appointment_Type: maxLength: 32 minLength: 1 type: string description: Unique identifier for the Appointment Type description: maxLength: 512 type: string description: Description of the Appointment Type nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommissionAppointmentTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionAppointmentType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionAppointmentTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionAppointmentType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionBasis: required: - commission_Basis type: object properties: commission_Basis: maxLength: 8 minLength: 1 type: string description: Unique identifier for the Commission Basis description: maxLength: 64 type: string description: Description of the Commission Basis nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommissionBasisListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionBasis' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionBasisVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionBasis' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionCategory: required: - commission_Category type: object properties: commission_Category: maxLength: 32 minLength: 1 type: string description: Unique identifier for the Commission Category description: maxLength: 512 type: string description: Description of the Commission Category nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommissionCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionCycle: required: - commission_Cycle type: object properties: commission_Cycle: maxLength: 8 minLength: 1 type: string description: Unique identifier for the Commission Cycle cycle_Frequency: type: integer description: Fequency of the Cycle format: int32 nullable: true cycle_Type: maxLength: 1 type: string description: Type of the Cycle nullable: true description: maxLength: 64 type: string description: Description of the Commission Cycle nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommissionCycleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionCycle' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionCycleVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionCycle' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionLicenseType: required: - license_Type type: object properties: license_Type: maxLength: 32 minLength: 1 type: string description: Unique identifier for the License Type description: maxLength: 512 type: string description: Description of the License Type nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommissionLicenseTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionLicenseType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionLicenseTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionLicenseType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Commission' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionParameter: required: - commissionActivity_Key - commissionParameter_Key type: object properties: commissionParameter_Key: type: integer format: int32 billedThru: type: string format: date-time nullable: true commissionActivity_Key: type: integer format: int32 commissionAgencyRepKey: type: integer format: int32 nullable: true commissionDate: type: string format: date-time nullable: true commissionDateType: maxLength: 1 type: string nullable: true end_Date: type: string format: date-time nullable: true groupID: maxLength: 20 type: string nullable: true receivedThru: type: string format: date-time nullable: true start_Date: type: string format: date-time nullable: true undo_Date: type: string format: date-time nullable: true undo_User: maxLength: 16 type: string nullable: true userID: maxLength: 20 type: string nullable: true additionalProperties: false CommissionParameterListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionParameter' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionParameterVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionParameter' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRate: required: - commissionRate_Key - pre_Payment_Rate - scale_Exclude_Header_Adjustments - use_Initial_Premium type: object properties: commissionRate_Key: type: integer description: 'Unique identifier for the Commission Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 account_Key: type: integer description: Account of the Commission Rate format: int32 nullable: true commissionRate_Category: maxLength: 32 type: string description: Category of the Commission Rate nullable: true commissionRate_ID: maxLength: 32 type: string description: User defind identifier for the Commission Rate nullable: true commissionRate_Type: maxLength: 16 type: string description: Type of the Commission Rate nullable: true commission_Basis: maxLength: 8 type: string description: Commission Basis used for the rate nullable: true commission_Cycle: maxLength: 8 type: string description: Commission Cycle used for the rate nullable: true description: maxLength: 128 type: string description: Description of the Commission Rate nullable: true division_ID: maxLength: 20 type: string description: Division of the Commission Rate nullable: true effective_Date: type: string description: Effective Date of the Commission Rate format: date-time nullable: true end_Date: type: string description: End Date of the Commission Rate format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true group_ID: maxLength: 20 type: string description: Group of the Commission Rate nullable: true issue_Age_From: type: integer description: Holds the lower bound of the applicable age range for the commission rate record. format: int32 nullable: true issue_Age_Thru: type: integer description: Holds the upper bound of the applicable age range for the commission rate record. format: int32 nullable: true issue_State: maxLength: 2 type: string description: Holds the abbreviated state name for the commission rate record. nullable: true member_Seq: maxLength: 2 type: string description: Member Sequnce of the Commission Rate nullable: true parent_CommissionRate_Key: type: integer description: Commission Rate that this record is a child of format: int32 nullable: true parent_Rate_Cluster: maxLength: 32 type: string description: Defines which CommissionRateCluster.Rate_Cluster is a parent to this commission rate record. nullable: true payor_ID: maxLength: 20 type: string description: Payor of the Commission Rate nullable: true plan_ID: maxLength: 20 type: string description: Plan of the Commission Rate nullable: true plan_Type: maxLength: 6 type: string description: Holds the plan_type for which this commission rate record applies. nullable: true pre_Payment_Adjustment_Reason: maxLength: 8 type: string description: TBD nullable: true pre_Payment_Rate: type: boolean description: 'TBD Note: This field is marked as NOT NULL in the database and therefore required by the API.' pre_Payment_Type: maxLength: 32 type: string description: TBD nullable: true premRate_Key: type: integer description: Not used format: int32 nullable: true rate: type: number description: Decimal value that defines the base rate format: double nullable: true rate_Max: type: number description: Maximum the rate will be regardless of the calculation format: double nullable: true rate_Min: type: number description: Minimum the rate will be regardless of the calculation format: double nullable: true rate_Round_Precision: type: integer description: Precision that the rate is rounded to format: int32 nullable: true rate_Round_Type: maxLength: 16 type: string description: Type that determine how the rate is rounded nullable: true rate_Variable1: type: number description: First variable used in calculating the rate based on the type format: double nullable: true rate_Variable2: type: number description: Second variable used in calculating the rate based on the type format: double nullable: true rate_Variable3: type: number description: Third variable used in calculating the rate based on the type format: double nullable: true scale_Exclude_Header_Adjustments: type: boolean description: 'Determines if Header Adjustments are included in the scaling Note: This field is marked as NOT NULL in the database and therefore required by the API.' scale_From: type: number description: Beginning range of the amount used for scaling format: double nullable: true scale_Thru: type: number description: Ending range of the amount used for scaling format: double nullable: true scale_Timeframe: maxLength: 16 type: string description: Used to detemine what date to begin the range for scaling nullable: true scale_Type: maxLength: 16 type: string description: Determines what amount the scale is based off of nullable: true subscriber_ID: maxLength: 9 type: string description: Subscriber of the Commission Rate nullable: true term_Range_Date_Type: maxLength: 16 type: string description: Used to detemine what date to begin the range for scaling nullable: true term_Range_From: type: integer description: 'Beginning range of a number of Days, Months, or Years' format: int32 nullable: true term_Range_Thru: type: integer description: 'Ending range of a number of Days, Months, or Years' format: int32 nullable: true term_Range_Type: maxLength: 1 type: string description: 'Determines if Term Range is Days, Months, or Years' nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true use_Initial_Premium: type: boolean description: 'Flag to calculate commission based on the first calculated premium for this rate and then agent. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false CommissionRateCluster: required: - rate_Cluster type: object properties: rate_Cluster: maxLength: 32 minLength: 1 type: string description: Unique identifer for the Rate Cluster cluster_Level: maxLength: 32 type: string nullable: true description: maxLength: 512 type: string description: Description of the rate Cluster nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommissionRateClusterAgencyRep: required: - commissionRateClusterAgencyRep_Key type: object properties: commissionRateClusterAgencyRep_Key: type: integer description: 'Unique identifer for the Commission Rate Cluster Agency Rep Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 commissionAgencyRep_Key: type: integer description: Unique identifier for the CommissionAgencyRep format: int32 nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true parent_CommissionAgencyRep_Key: type: integer description: Parent key for the CommissionAgencyRep record this is a child of format: int32 nullable: true rate_Cluster: maxLength: 32 type: string description: Unique identifer for the Rate Cluster nullable: true split: type: number description: The amount or percentage of the split format: double nullable: true split_Max: type: number description: Maximum amount of the split format: double nullable: true split_Min: type: number description: Minimum amount of the split format: double nullable: true split_Priority: type: integer description: Priority of the split format: int32 nullable: true split_Type: maxLength: 16 type: string description: Determines if split is percent or flat amount nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CommissionRateClusterAgencyRepListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionRateClusterAgencyRep' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRateClusterAgencyRepVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionRateClusterAgencyRep' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRateClusterListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionRateCluster' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRateClusterRate: required: - commissionRate_Key - rate_Cluster type: object properties: rate_Cluster: maxLength: 32 minLength: 1 type: string commissionRate_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CommissionRateClusterRateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionRateClusterRate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRateClusterRateVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionRateClusterRate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRateClusterVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionRateCluster' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionRate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRateNested: type: object properties: group_ID: type: string nullable: true group_Name: type: string nullable: true divisionConfigs: type: array items: $ref: '#/components/schemas/CommissionRate_DivisionConfig' nullable: true additionalProperties: false CommissionRateNestedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionRateNested' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRateSubscriber: required: - commissionRate_Key - subscriber_ID type: object properties: commissionRate_Key: type: integer format: int32 subscriber_ID: maxLength: 9 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CommissionRateSubscriberListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionRateSubscriber' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRateSubscriberVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionRateSubscriber' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRateVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionRate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRate_DivisionConfig: type: object properties: division_ID: type: string nullable: true division_Name: type: string nullable: true planConfigs: type: array items: $ref: '#/components/schemas/CommissionRate_PlanConfig' nullable: true additionalProperties: false CommissionRate_PlanConfig: type: object properties: plan_ID: type: string nullable: true plan_Description: type: string nullable: true rates: type: array items: $ref: '#/components/schemas/CommissionRate_Rate' nullable: true additionalProperties: false CommissionRate_Rate: type: object properties: commissionRate_Key: type: integer format: int32 rate_Description: type: string nullable: true additionalProperties: false CommissionRep: required: - commissionRep_Key - email_Statement type: object properties: commissionRep_Key: type: integer format: int32 address: maxLength: 128 type: string nullable: true address2: maxLength: 128 type: string nullable: true city: maxLength: 32 type: string nullable: true country_ID: maxLength: 8 type: string nullable: true county_Code: maxLength: 8 type: string nullable: true eMail_Address: maxLength: 256 type: string nullable: true email_Statement: type: boolean entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true fax_Country_Code: maxLength: 8 type: string nullable: true fax_Number: maxLength: 32 type: string nullable: true first_Name: maxLength: 32 type: string nullable: true last_Name: maxLength: 32 type: string nullable: true middle_Name: maxLength: 32 type: string nullable: true phone_Country_Code: maxLength: 8 type: string nullable: true phone_Extension: maxLength: 16 type: string nullable: true phone_Number: maxLength: 32 type: string nullable: true rep_Type: maxLength: 32 type: string nullable: true ssn: maxLength: 32 type: string nullable: true state: maxLength: 2 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true zip_Code: maxLength: 32 type: string nullable: true additionalProperties: false CommissionRepAccount: required: - account_Key - commissionRep_Key - commissionRepAccount_Key type: object properties: commissionRepAccount_Key: type: integer format: int32 account_Key: type: integer format: int32 commissionRep_Key: type: integer format: int32 effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CommissionRepAccountListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionRepAccount' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRepAccountVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionRepAccount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRepAppoint: required: - commissionRep_Key - commissionRepAppoint_Key type: object properties: commissionRepAppoint_Key: type: integer format: int32 appointment_ID: maxLength: 64 type: string nullable: true appointment_State: maxLength: 2 type: string nullable: true appointment_Type: maxLength: 32 type: string nullable: true commissionRep_Key: type: integer format: int32 effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CommissionRepAppointListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionRepAppoint' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRepAppointVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionRepAppoint' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRepGroup: required: - commissionRep_Key - commissionRepGroup_Key - group_ID type: object properties: commissionRepGroup_Key: type: integer format: int32 commissionRep_Key: type: integer format: int32 division_ID: maxLength: 20 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true group_ID: maxLength: 20 minLength: 1 type: string update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CommissionRepGroupListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionRepGroup' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRepGroupVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionRepGroup' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRepLicense: required: - commissionRep_Key - commissionRepLicense_Key type: object properties: commissionRepLicense_Key: type: integer format: int32 commissionRep_Key: type: integer format: int32 effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true license_Number: maxLength: 128 type: string nullable: true license_State: maxLength: 2 type: string nullable: true license_Type: maxLength: 32 type: string nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CommissionRepLicenseListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionRepLicense' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRepLicenseVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionRepLicense' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRepListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionRep' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRepSubscriber: required: - commissionRep_Key - commissionRepSubscriber_Key - subscriber_ID type: object properties: commissionRepSubscriber_Key: type: integer format: int32 commissionRep_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true subscriber_ID: maxLength: 9 minLength: 1 type: string update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CommissionRepSubscriberListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionRepSubscriber' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRepSubscriberVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionRepSubscriber' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRepType: required: - rep_Type type: object properties: rep_Type: maxLength: 32 minLength: 1 type: string description: Unique identifier for Rep Type description: maxLength: 512 type: string description: Description of the Rep Type nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true first_Year_Account: maxLength: 128 type: string description: Informational nullable: true renewal_Account: maxLength: 128 type: string description: Informational nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommissionRepTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionRepType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRepTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionRepType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionRepVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionRep' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionTransaction: required: - commissionTransaction_Key type: object properties: commissionTransaction_Key: type: integer format: int32 check_Batch: type: integer format: int32 nullable: true comm_Date: type: string format: date-time nullable: true description: maxLength: 64 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true transaction_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CommissionTransactionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommissionTransaction' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionTransactionVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommissionTransaction' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommissionVBAResponse: type: object properties: data: $ref: '#/components/schemas/Commission' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommunicationMethod: required: - communication_Method type: object properties: communication_Method: maxLength: 16 minLength: 1 type: string description: Unique identifier for the CommissionMethod table description: maxLength: 128 type: string description: Description of the Communication Method nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CommunicationMethodListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CommunicationMethod' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CommunicationMethodVBAResponse: type: object properties: data: $ref: '#/components/schemas/CommunicationMethod' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CompanyData: required: - additional_Invoice_Rates - adv_Password_Req - allow_Apostrophe_In_Name - allow_Checks_Post_Date - allow_Claim_Benefit_Override - allow_OOP_On_Override - anesthesia_By_Fee_Sched - apply_Multiple_Benefit_ExCode_Manual - auto_Adj_Return_To_Batch - auto_Pay_Capitated_Claims - auto_Process_Adjustment_Backout - auto_Term_Plan_On_Gateway_Request - baseLoadServiceDateFlag - cap_By_Service_Line - caS_Segment_Ben_Match - case_Default_Report - checkPayeeAddressFlag - claim_Not_Enrolled_Ex_Code_Null_Use_Pre_Post - clear_Auth_Penalty_ExCode - combined_Notes_Report_Fg - context4_PlanPriceNotGreaterBilledFg - context4_SendBillingAddressFg - coPay_By_Billed - credential_By_Payee - diagnostic_Code_Type_Default - disallow_Spec_Char_In_Plan_ID - disconnect_Call_Notes_From_Claim_Provider - display_PPO_Null_Network - enforce_MFA - error_Invalid_Diag - error_Invalid_Proc - error_Multiple_Plan_Years - error_Termed_Provider - fee_Sched_Match_Claim_Year - fee_Schedule_Ex_Codes_Manual - fee_Schedule_Exact_Match_Fg - force_Call_Track_Note - force_Claim_Rec_Date - force_Latest_Enrollment - force_Leading_Zero_On_Rev_Code - full_Backout_On_Void_Distribution - full_Month_Billing - generate_Negative_Inv - ignore_Care_Management_Hierarchy_Fg - ignore_Claim_Funding_Status_Change_Msg - include_Invalid_Enrollments - invoice_Enrolled_By - key_Value - lag_Time - lock_Auth_Review - lock_Auth_Review_All - log_BaseLoad_Call - mail_Use_SSL - medicare_On_Benefit - member_Address_DOB_Not_Reqd - member_Match_By_Name_BirthDate - note_Attachment_DB - partial_Cap - payment_Proration - premium_Proration - prevent_Suspense_Release_By_Process_User - process_Auths_When_Pended - process_Auto_COB - protect_Alternate_ID - reins_Split_Claim - request_ID_Card_Prompt_Enrollment - restrict_NPI_Federal_ID - set_Paid_Through - single_Refund_Check_Batch - tax_On_Adjudcation_Date_Fg - uC_Unit_Mulitply - use_Auth_Over_Unit_Split - use_Change_Data_Capture - use_Commission_Cluster_Hierarchy - use_Currency - use_Disability_From_Date - use_Expanded_Notes - use_First_Match_Pricing - use_Primary_Diag_Match - use_Primary_Diag_Match_Capitation - use_Salary - use_Tax_Control - use_VBAdjudicate_2 - use_VBASoftware_2 - use_Zip_Code_Auto_Populate - useGreaterUserAmountLimit_Fg - validate_Federal_ID_On_Auth - validate_Provider_On_Auth - vbaDataIntegration - vbaGateway - vbaGateway_SFTP_MLST - vbaGateway_SFTP_Passive - vbapI_Field_Masking_Enabled - vbapI_IP_Whitelist - vbaReport_Mail_Use_SSL - void_Backout_Use_Current_Date - zelis_Poll - zelis_Poll_Testing type: object properties: key_Value: type: integer description: 'This value is always 1 and there can only be a single record in the CompanyData table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 apC_Schedule: maxLength: 16 type: string description: Default APC Schedule to be used nullable: true asO_Percentage: type: number description: Not used in system configuration. Used on external and/or custom procedures. format: double nullable: true accident_Review_Ex_Code: maxLength: 6 type: string description: 'When a Diagnosis Code is marked as an Accident, or a Plan Benefit is marked as an accident and the Diagnosis Code is not marked as an accident, trigger this Ex Code' nullable: true accident_Review_Plan_Benefit_Ex_Code: maxLength: 6 type: string description: 'When a Plan Benefit is marked as an accident and the Diagnosis Code is not marked as an accident, trigger this Ex Code' nullable: true additional_Invoice_Rates: type: boolean description: 'No longer used in the system Note: This field is marked as NOT NULL in the database and therefore required by the API.' address: maxLength: 60 type: string description: Address of the Company. nullable: true address2: maxLength: 128 type: string description: Line 2 of the Client's address. nullable: true adv_Password_Req: type: boolean description: 'Requires passwords to have 3 of the following: Uppercase Letter, Lowercase Letter, Number, Special Character Note: This field is marked as NOT NULL in the database and therefore required by the API.' age_Disenroll_Reason: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true allow_Apostrophe_In_Name: type: boolean description: 'Whether or not the Apostrophe is allowed in Provider or Member names Note: This field is marked as NOT NULL in the database and therefore required by the API.' allow_Checks_Post_Date: type: boolean description: 'This option will allow for post dated checks. Note: This field is marked as NOT NULL in the database and therefore required by the API.' allow_Claim_Benefit_Override: type: boolean description: 'Allows Benefit Override Note: This field is marked as NOT NULL in the database and therefore required by the API.' allow_Max_At_Subscriber: maxLength: 1 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true allow_OOP_On_Override: type: boolean description: 'When selected, OOP will be calculated even when overridden Note: This field is marked as NOT NULL in the database and therefore required by the API.' allow_Zero_Billed: maxLength: 1 type: string description: This options allows claims to be process with a '0.00' billed amount. nullable: true anesthesia_By_Fee_Sched: type: boolean description: 'When selected, use the matching under Anesthesia for Fee Schedules when an Anastesia Procedure Code/Modifier is present. Note: This field is marked as NOT NULL in the database and therefore required by the API.' anesthesia_Round_Precision: type: integer description: 'The precision of rounding used for Anesthesia Units Note: The database will apply a default value of `0` for this field if a value is not provided.' format: int32 nullable: true anesthesia_Round_Type: maxLength: 16 type: string description: The type of rounding used for Anesthesia Units nullable: true apply_Multiple_Benefit_ExCode_Manual: type: boolean description: 'If Ex Code is set and all benefits match, set to the first benefit code and set the Ex Code. If Apply_Multiple_Benefit_ExCode_Manual is set to 1 (checked) then the ex code is applied as a Manual ex code, which is not cleared on future adjudications and requires a client to manually clear it Note: This field is marked as NOT NULL in the database and therefore required by the API.' authReview_Full_Path: maxLength: 255 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true authReview_Object: maxLength: 255 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true auth_Code_Closed: maxLength: 8 type: string description: 'If after processing a claim, there are no more remaining units left for an Auth that was used on the claim, set the Auth Code on the Auth to this Code' nullable: true auth_Code_Pay_Amt_Zero: maxLength: 8 type: string description: When a claim with an auth has a payable amount of zero nullable: true auth_Code_Reopen: maxLength: 8 type: string description: 'If after returning a claim to batch, if there are remaining units left for an Auth that was used on the claim, set the Auth Code on the Auth to this Code' nullable: true auth_Code_Under_Auth_Amt: maxLength: 8 type: string description: When a claim with an auth has a payable amount under the approved amount on the auth nullable: true auth_Over_Unit_Split_Ex_Code: maxLength: 8 type: string description: Ex Code to use when spliting Authorizations nullable: true auth_Penalty_Ex_Code: maxLength: 6 type: string description: 'If filled out and an Auth Penalty is found, insert the Ex Code' nullable: true auto_Adj_Return_To_Batch: type: boolean description: 'This flag indicates claims being returned to batch will be automatically adjudicated. Note: This field is marked as NOT NULL in the database and therefore required by the API.' auto_Pay_Capitated_Claims: type: boolean description: 'Auto pays Capitated claims and Creates a Check Batch Note: This field is marked as NOT NULL in the database and therefore required by the API.' auto_Process_Adjustment_Backout: type: boolean description: 'Whether or not to automatically process the Backout of a claim after an adjustment Note: This field is marked as NOT NULL in the database and therefore required by the API.' auto_Term_Plan_On_Gateway_Request: type: boolean description: 'This is a flag indicating that when a Gateway request for coverage is confirmed, if the member has an existing plan of the same plan type, it will be termed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' bR_Domain_Name: maxLength: 256 type: string description: 'For Bold Reports integration, this identifies the Domain Name. Used only by VBA developers, not for client use.' nullable: true bR_Site_Name: maxLength: 256 type: string description: 'For Bold Reports integration, this identifies the Site Name. Used only by VBA developers, not for client use.' nullable: true bR_Site_Secret: maxLength: 256 type: string description: 'For Bold Reports integration, this identifies the Site Secret. Used only by VBA developers, not for client use.' nullable: true bR_Site_User: maxLength: 256 type: string description: 'For Bold Reports integration, this identifies the Site User. Used only by VBA developers, not for client use.' nullable: true baseLoadFg: type: boolean description: Whether or not BaseLoad is turned on nullable: true baseLoadPass: maxLength: 256 type: string description: BaseLoad Password nullable: true baseLoadServiceDateFlag: type: boolean description: 'This flag denotes whether or not to include the Service Date within the BaseLoad XML sent to BaseLoad Note: This field is marked as NOT NULL in the database and therefore required by the API.' baseLoadURL: maxLength: 8000 type: string description: BaseLoad URL nullable: true baseLoadUser: maxLength: 256 type: string description: BaseLoad User ID nullable: true beneficiary_AgeLimit: type: number description: Minimum Age for a Beneficiary format: double nullable: true beneficiary_Age_Ex_Code: maxLength: 8 type: string description: This pend code will be applied when the beneficiary age defined on the enrollment is invalid. nullable: true benefit_Cascade_Ex_Code: maxLength: 8 type: string description: This Informational Ex Code will be applied to a claim detail line when the benefit is defined as cascading in the plan and the necessary criteria have been met to cascade the benefits. nullable: true benefit_Length: type: number description: Not used in system configuration. Used on external and/or custom procedures. format: double nullable: true bridged_Tooth_Ex_Code: maxLength: 8 type: string description: This pend code will be applied when the tooth number on the claim is found to have been previously bridged. nullable: true caS_Segment_Ben_Match: type: boolean description: 'This flag indicates that the adjudication benefit matching will use custom logic for CAS assignments from inbound 837 files. This option is set and controlled by VBA developers and not for client use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' cliA_Certificate_Ex_Code: maxLength: 6 type: string description: This Denial Ex Code will deny a claim when a CLIA certificate is required and the provider record does not have CLIA certification. nullable: true cmO_Installed: maxLength: 1 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true cap_By_Service_Line: type: boolean description: 'Claim will error if number of the Claim has Mixed Capitation Service Lines unless this is checked. Note: This field is marked as NOT NULL in the database and therefore required by the API.' cap_Disenroll_Adj_Reason: maxLength: 8 type: string description: Default Capitation Disenroll Adjustment reason nullable: true cap_Enroll_Adj_Reason: maxLength: 8 type: string description: Default Capitation Enroll Adjustment reason nullable: true cap_Enrolled_By: type: integer description: This setting defines the Enrollment date the application uses for Calculating a Capitated Providers payment. format: int32 nullable: true cap_Enrolled_Thru: type: integer description: This setting defines the Enrollment date the application uses for Calculating a Capitated Providers payment. format: int32 nullable: true cap_In_Accum: type: boolean description: 'Not used in system configuration. Used on external and/or custom procedures. Note: The database will apply a default value of `False` for this field if a value is not provided.' nullable: true capitated_Service_Ex_Code: maxLength: 8 type: string description: This Informational Ex Code will be applied to a claim detail line when services are Capitated. nullable: true case_Default_Report: maxLength: 256 minLength: 1 type: string description: 'The Default Case Report when using the Case Report functionality from Case Update Note: This field is marked as NOT NULL in the database and therefore required by the API.' cash_Value_Default: type: integer description: Default Issue Duratoin Value for Cash Type format: int32 nullable: true checkPayeeAddressFlag: type: boolean description: 'When selected, if the payee address is not filled out, error the claim Note: This field is marked as NOT NULL in the database and therefore required by the API.' check_Stock_Location: maxLength: 128 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true checks_Max_Post_Date: type: integer description: Adds an error during the Check Wizard if the Check Date exceeds the threshold set here format: int32 nullable: true city: maxLength: 20 type: string description: City of the Company's address. nullable: true claimUpload_Date: type: string description: Not used in system configuration. Used on external and/or custom procedures. format: date-time nullable: true claimUpload_File_Location: maxLength: 128 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claimUpload_Schedule: maxLength: 1 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Age_Ex_Code: maxLength: 6 type: string description: This Denial Ex Code will deny a claim in which the age definitions of the plan are exceeded. nullable: true claim_Allowed_Billed_Ex_Code: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Amt_Ex_Code: maxLength: 6 type: string description: This pend code will be applied when the claim billed amount exceeds the user max defined on the user information. nullable: true claim_Auth_Denied_Ex_Code: maxLength: 6 type: string description: 'If Filled out and an Auth Status is Denied, insert the Ex Code' nullable: true claim_Auth_Details_Err_Ex: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Auth_Diff_Mem_Ex: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Auth_Diff_Prov_Ex: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Auth_Exceeded_Ex_Code: maxLength: 6 type: string description: 'If Filled out and the Auth has exceeded the Approved, insert the Ex Code' nullable: true claim_Auth_Invalid_Date_Ex: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Auth_Not_Approved_Ex: maxLength: 6 type: string description: 'If Filled out and an Auth status is Not Approved, insert the Ex Code' nullable: true claim_Auth_Proc_Exceeded_Ex_Code: maxLength: 8 type: string description: 'If filled out and the number of Approved Procedure Units is exceeded, insert the Ex Code' nullable: true claim_Auth_Reqd_Ex_Code: maxLength: 6 type: string description: 'If filled out and an Auth is required, insert the Ex Code' nullable: true claim_Ben_Not_Found_Ex_Code: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Cov_In_Net_Only_Ex_Code: maxLength: 6 type: string description: Checking this indicates the Benefit is covered only when services are rendered using an In-Network provider. nullable: true claim_Days_Allowed: type: number description: Number of claim days allowed. format: double nullable: true claim_Dead_Ex_Code: maxLength: 6 type: string description: This Denial Ex Code will deny a claim for a member whose enrollment record indicates they are deceased. nullable: true claim_Ded_Credit_OON_Used_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when Deductible Credit is used for the claim Out of Network nullable: true claim_Ded_Credit_PPO_Used_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when Deductible Credit is used for the claim in Network nullable: true claim_Denied_Ex_Code: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Diagnosis_Age_Ex_Code: maxLength: 6 type: string description: This Ex Code is used when the Age is outside the range for the Diagnosis nullable: true claim_Diagnosis_Gender_Ex_Code: maxLength: 6 type: string description: This Ex Code is used when the Gender is not a valid Gender for the Diagnosis nullable: true claim_Dup_Error_Ex_Code: maxLength: 8 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Error_Ex_Code: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Exceed_Daily_CoPay_Max_Ex_Code: maxLength: 8 type: string description: 'if the CoPay has been adjusted due to previous CoPay amounts, Trigger this Ex Code' nullable: true claim_Exceed_Injury_Ex_Code: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Exceed_Lifetime_Ex_Code: maxLength: 6 type: string description: This Ex Code is used when the claim exceeds a Lifetime Max Payable nullable: true claim_Exceed_Lifetime_OON_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when the Lifetime Max Payable Out of Network has been exceeded nullable: true claim_Exceed_Lifetime_PPO_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when the Lifetime Max Payable In Network has been exceeded nullable: true claim_Exceed_Maximum_Ex_Code: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Exceed_PerDiem_Ex_Code: maxLength: 6 type: string description: This Informational Ex Code will be applied to a claim when the Per-Diem amount defined on the provider record has been exceeded. nullable: true claim_Fee_Sched_Error_Ex: maxLength: 6 type: string description: This pend code will be applied to a claim when the provider record indicates a fee schedule is required but no fee schedule is assigned to the provider. nullable: true claim_Lag_Error_Ex_Code: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Late_Ex_Code: maxLength: 6 type: string description: This Denial Ex Code will deny a claim that exceeds the timely filing limits set. nullable: true claim_Life_Benefit_Met_Ex_Code: maxLength: 6 type: string description: This Ex Code is used when the Life Claim exceeds the Benefits Maximum nullable: true claim_Life_Plan_Met_Ex_Code: maxLength: 6 type: string description: This Ex Code is used when the Life Claim exceeds the Plan Maximum nullable: true claim_No_Prov_Fee_Sched: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_No_Rate_Fee_Ex_Code: maxLength: 8 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Not_Adult_Dependent: maxLength: 6 type: string description: This pend code will be applied to a claim when the date of service exceeds the date on the enrollment record for dependent coverage. nullable: true claim_Not_At_Place_Ex_Code: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Not_By_Prov_Ex_Code: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true claim_Not_Cov_Ex_Code: maxLength: 6 type: string description: This Denial Ex Code will deny a non-covered claim. nullable: true claim_Not_Enrolled_Ex_Code: maxLength: 6 type: string description: This Denial Ex Code will deny a claim that comes in for a member that is not enrolled for the date of service. nullable: true claim_Not_Enrolled_Ex_Code_Null_Use_Pre_Post: type: boolean description: 'When selected, instead of using the Not Enrolled Ex Code, put the Pre and Post Enrolled Ex Codes instead Note: This field is marked as NOT NULL in the database and therefore required by the API.' claim_Not_Enrolled_Post_Ex_Code: maxLength: 8 type: string description: This Denial Ex Code will deny a claim if services are after the enrollment date. nullable: true claim_Not_Enrolled_Pre_Ex_Code: maxLength: 8 type: string description: This Denial Ex Code will deny a claim if services are prior to the enrollment date. nullable: true claim_Not_Student_Ex_Code: maxLength: 6 type: string description: This pend code will be applied to a claim when the date of service exceeds the date on the enrollment record for student coverage. nullable: true claim_Other_Coverage_Ex_Code: maxLength: 6 type: string description: This Ex Code is used when the Authorization has Other Coverage Primary selected nullable: true claim_Over_Max_Ex_Code: maxLength: 6 type: string description: This Ex Code is used when the claim exceeds an Annual Max Payable nullable: true claim_Over_Max_OON_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when the Annual Max Payable Out of Network has been exceeded nullable: true claim_Over_Max_PPO_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when the Annual Max Payable In Network has been exceeded nullable: true claim_Pend_Age_Max: type: integer description: Trigger the Claim Age Ex Code when the Age of the Patient is above this value format: int32 nullable: true claim_Pend_Age_Min: type: integer description: Trigger the Claim Age Ex Code when the Age of the Patient is below this value format: int32 nullable: true claim_Pend_Amount: type: number description: Trigger the Claim Amt Ex Code when the Claim Payable exceeds this amount format: double nullable: true claim_Procedure_Age_Ex_Code: maxLength: 6 type: string description: This Denial Ex Code will deny a claim when the procedure code/diagnosis code is defined for a specific age. nullable: true claim_Procedure_Gender_Ex_Code: maxLength: 6 type: string description: This Denial Ex Code will deny a claim when the procedure code/diagnosis code is defined for a specific gender. nullable: true claim_Service_Date_Range: type: integer description: 'If outside the payable date range (this value represents days ahead from date of adjudication), error' format: int32 nullable: true claim_Service_Outside_Enrollment_Ex_Code: maxLength: 6 type: string description: When a Service Thru date happens outside the normal plan end date nullable: true claim_Splits_Plan_Year_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when multiple Plan Years found nullable: true class_Length: type: number description: Not used in system configuration. Used on external and/or custom procedures. format: double nullable: true clear_Auth_Penalty_ExCode: type: boolean description: 'A flag indicating that any Auth Penalty Ex Code will be removed from a claim line if it has an auth associated. Note: This field is marked as NOT NULL in the database and therefore required by the API.' client_ID: maxLength: 6 type: string description: Client's 3 character ID nullable: true client_Name: maxLength: 90 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true coIns_Max_Ex_Code: maxLength: 8 type: string description: This Informational Ex Code will be applied to a claim when the Subscriber level Coinsurance has been met for the family. An Info code must be applied as a claim detail line may have a partial denial. A deny code will deny the entire line. nullable: true coIns_Max_Ex_Code_Member: maxLength: 8 type: string description: This Informational Ex Code will be applied to a claim when the Member Coinsurance has been satisfied. An Info code must be applied as a claim detail line may have a partial denial. A Deny code would deny the entire detail line. nullable: true coPay_By_Billed: type: boolean description: 'Co-Pay based on Billed Amount rather than Plan_Price Note: This field is marked as NOT NULL in the database and therefore required by the API.' cogito_App_Client_ID: maxLength: 128 type: string description: The app client ID associated with the user pool. Exclusively for use in VBASoftware and VBAPI Cognito integration with AWS. nullable: true cogito_App_Client_Secret: maxLength: 256 type: string description: The app client Secret associated with the user pool. Exclusively for use in VBASoftware and VBAPI Cognito integration with AWS. nullable: true cogito_User_Pool_ID: maxLength: 64 type: string description: The ID of the Amazon Cognito user pool. Exclusively for use in VBASoftware and VBAPI Cognito integration with AWS. nullable: true combined_Notes_Report_Fg: type: boolean description: 'When this flag is set to yes, the notes report from the Notes screen will remove the page breaks Note: This field is marked as NOT NULL in the database and therefore required by the API.' comm_Disenroll_Adj_Reason: maxLength: 8 type: string description: Default Commisssion Disenroll Adjustment Reason nullable: true comm_Enroll_Adj_Reason: maxLength: 8 type: string description: Default Commisssion Enroll Adjustment Reason nullable: true comm_Enrolled_By: type: integer description: Default Commisssion Enrolled By value format: int32 nullable: true comm_Enrolled_Thru: type: integer description: Default Commisssion Enrolled Thru value format: int32 nullable: true company_Length: type: number description: Not used in system configuration. Used on external and/or custom procedures. format: double nullable: true company_Short: maxLength: 4 type: string description: Client ID of the Client nullable: true company_Start_Date: type: string description: The date used to avoid using data prior to the date the company starts with VBA. format: date-time nullable: true context4_ClmUcrPct: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true context4_ClmUcrPct_OON: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true context4_FeeSelector: maxLength: 8 type: string description: The type of Fee for Context4 Pricing nullable: true context4_FeeSelector_OON: maxLength: 8 type: string description: The type of Fee for Context4 Pricing when OON nullable: true context4_MedicarePct: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true context4_MedicarePct_OON: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true context4_Password: maxLength: 128 type: string description: The Password for Context4 Pricing nullable: true context4_PayorType: maxLength: 8 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true context4_PayorType_OON: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true context4_PctOfChg: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true context4_PctOfChg_OON: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true context4_PlanPriceNotGreaterBilledFg: type: boolean description: 'When set, if Plan Price exceeds Billed Price, set Plan Price equal to Billed Price for Context4 Note: This field is marked as NOT NULL in the database and therefore required by the API.' context4_SendBillingAddressFg: type: boolean description: 'Whether or not the Billing Address information is sent to Context4 Note: This field is marked as NOT NULL in the database and therefore required by the API.' context4_UserID: maxLength: 128 type: string description: The User ID for Context4 Pricing nullable: true context4_WebURI: maxLength: 256 type: string description: The WebURI for Context4 Pricing nullable: true context4_WebURI_Delete: maxLength: 256 type: string description: The Delete WebURI for Context4 Pricing nullable: true copay_Ex_Code: maxLength: 6 type: string description: The Ex Code to apply when adjudicating a claim that has a copay greater than zero. nullable: true country_ID: maxLength: 8 type: string description: Default Country nullable: true credential_By_Payee: type: boolean description: 'Flag to create a row in office location of the provider''s practice with data from the corresponding payee record instead of provider. Note: This field is marked as NOT NULL in the database and therefore required by the API.' credentialing: maxLength: 1 type: string description: 'When selected, turn on Credentialing' nullable: true crowned_Tooth_Ex_Code: maxLength: 8 type: string description: This pend code will be applied when the tooth number on the claim is found to have been previously crowned. nullable: true currency_Format: maxLength: 20 type: string description: Used for currency format when saving to Excel in Formatted nullable: true dB_Version_Date: type: string description: Not used in system configuration. Used on external and/or custom procedures. format: date-time nullable: true drG_Schedule: maxLength: 16 type: string description: Selection this option will set the default DRG schedule. nullable: true database_Version: maxLength: 32 type: string description: Stores the latest Release Version nullable: true date_Format: maxLength: 20 type: string description: Date format used when saving reports as formatted Excel nullable: true deductible_Ex_Code: maxLength: 6 type: string description: The Ex Code to apply when adjudicating a claim that has a deductible greater than zero. nullable: true deductible_Max_Ex_Code: maxLength: 8 type: string description: This Informational Ex Code will be applied to a claim when the Subscriber level deductible has been met for the family. An Info code must be applied as a claim detail line may have a partial denial. A deny code will deny the entire line. nullable: true deductible_Max_Ex_Code_Member: maxLength: 8 type: string description: This Informational Ex Code will be applied to a claim when the Member Deductible has been satisfied. An Info code must be applied as a claim detail line may have a partial denial. A Deny code would deny the entire detail line. nullable: true default_1099_Flag: maxLength: 1 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true default_Auth_Code: maxLength: 8 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true default_Check_Stock: type: integer description: Defines the default check stock. format: int32 nullable: true default_Currency_ID: maxLength: 16 type: string description: Default Currency to be used nullable: true default_EOB_Report: type: integer description: Defines the default EOB report. format: int32 nullable: true default_Federal_Tax: type: number description: Not used in system configuration. Used on external and/or custom procedures. format: double nullable: true default_Federal_Tax_Day_Limit: type: integer description: Default limit to when Federal Tax applies format: int32 nullable: true default_Federal_Tax_Pct: type: number description: The default Federal Tax percentage format: double nullable: true default_Federal_Wage_Limit: type: number description: Default limit to the amount of wages that can be used to calculate Federal Tax format: double nullable: true default_ID_Card_Request_Type: maxLength: 16 type: string description: Indicates the desired default format for generated IDs. nullable: true default_Invoice_ReportDefinition_Key: type: integer description: A part of invoice Process Automation format: int32 nullable: true default_Login_Sound: maxLength: 255 type: string description: Sets the default login sound. nullable: true default_Medicare_Tax_Day_Limit: type: integer description: Default limit to when Medicare Tax applies format: int32 nullable: true default_Medicare_Wage_Limit: type: number description: Default limit to the amount of wages that can be used to calculate Medicare Tax format: double nullable: true default_Pay_Date_Range: type: integer description: Used to calculate the Check Paid Date format: int32 nullable: true default_Payor_ID: maxLength: 10 type: string description: Payor ID that is defaulted to. nullable: true default_SS_Tax_Day_Limit: type: integer description: Default limit to when Social Security Tax applies format: int32 nullable: true default_SS_Wage_Limit: type: number description: Default limit to the amount of wages that can be used to calculate Social Security Tax format: double nullable: true default_State_Tax_Day_Limit: type: integer description: Default limit to when State Tax applies format: int32 nullable: true default_State_Wage_Limit: type: number description: Default limit to the amount of wages that can be used to calculate State Tax format: double nullable: true dental_ATP_Paid_Date_Type: maxLength: 32 type: string description: Holds the selected setting for ATP Paid Date on Dental Claims (Standard or by Processed Date) nullable: true diagnostic_Code_Type_Default: maxLength: 16 minLength: 1 type: string description: 'Default Diagnostic Code Type for Disability and Life claims Note: This field is marked as NOT NULL in the database and therefore required by the API.' disallow_Spec_Char_In_Plan_ID: type: boolean description: 'This flag disallows special characters to be used in the Plan ID column. Note: This field is marked as NOT NULL in the database and therefore required by the API.' disconnect_Call_Notes_From_Claim_Provider: type: boolean description: 'This is a flag indicating that when viewing notes from Call Tracking, provider and claim notes associated with the call record will not be displayed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' disenroll_Adj_Reason: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true disenroll_Auth_Code: maxLength: 8 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true display_PPO_Null_Network: type: boolean description: 'When selected, if the claim is Out of Network, show zero dollars in the PPO Discount Note: This field is marked as NOT NULL in the database and therefore required by the API.' division_Length: type: number description: Not used in system configuration. Used on external and/or custom procedures. format: double nullable: true dup_Password_Days: type: integer description: Sets the number of days before a password may be duplicated (reused). format: int32 nullable: true duplicateMaster_Key: type: integer description: Choose the applicable duplicate rule for the application. See Duplicate Sets in Claim Services > Claim Configuration to maintain the Duplicate Rule options. format: int32 nullable: true edI_Installed: maxLength: 1 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true eoB_Disclaimer: type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true eoB_Report_Location: maxLength: 255 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true eR_Place_Of_Service: maxLength: 5 type: string description: Choose the applicable place of service for emergency room services. nullable: true enforce_MFA: type: boolean description: 'Note: This field is marked as NOT NULL in the database and therefore required by the API.' enroll_Adj_Reason: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true error_Invalid_Diag: type: boolean description: 'Checking this box will cause claims to error if an invalid Diagnosis Code is billed. Left unchecked with a deny Ex Code selected the line item will automatically deny. Note: This field is marked as NOT NULL in the database and therefore required by the API.' error_Invalid_Proc: type: boolean description: 'Checking this box will cause claims to error if an invalid Procedure Code is billed. Left unchecked with a deny Ex Code selected the line item will automatically deny. Note: This field is marked as NOT NULL in the database and therefore required by the API.' error_Multiple_Plan_Years: type: boolean description: 'When selected, if there are multiple Plan Years found, error instead of triggering Claim Splits Plan Year Ex Code Note: This field is marked as NOT NULL in the database and therefore required by the API.' error_Paid_To_Provider: type: boolean description: 'If selected and there''s no Payee assigned to the Provider, set Send_Check_To Provider Note: The database will apply a default value of `False` for this field if a value is not provided.' nullable: true error_Termed_Provider: type: boolean description: 'Checking this box will cause claims to error if a Termed Provider is selected. Left unchecked with a deny Ex Code selected the claim will automatically deny. Note: This field is marked as NOT NULL in the database and therefore required by the API.' exceed_Exhaust_Date_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when the Service Date exceeds the Exhause Date on a Disability Claim nullable: true exceed_Return_To_Work_Ex_Code: maxLength: 8 type: string description: This pend code will be applied when the claim date of service exceeds the date defined as the return to work day on the disability claim. nullable: true exceeds_PaidThrough_Ex_Code: maxLength: 8 type: string description: This pend code will be applied when the claim date of service exceeds the paid through date defined on the member record. nullable: true extended_Term_Default: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true fax_Country_Code: maxLength: 8 type: string description: Country Code for the fax number of the Subscriber. nullable: true fax_Number: maxLength: 20 type: string description: Fax number of the Client. nullable: true federal_ID: maxLength: 20 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true fee_Sched_Match_Claim_Year: type: boolean description: 'No longer used in the system Note: This field is marked as NOT NULL in the database and therefore required by the API.' fee_Schedule_Ex_Codes_Manual: type: boolean description: 'When this is checked, Fee Schedule Ex Codes from the FeeSched and FeeSchedDetail tables will be added as MANUAL ex codes. This means adjudication will not wipe these away at the start of adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.' fee_Schedule_Exact_Match_Fg: type: boolean description: 'Whether or not the Modifiers of a Fee Schedule have to match exact Note: This field is marked as NOT NULL in the database and therefore required by the API.' filled_Tooth_Ex_Code: maxLength: 8 type: string description: Ex Code to set when the member has Filled a Tooth nullable: true first_Benefit_Auto_Selected_Ex_Code: maxLength: 6 type: string description: Ex code that is added when a benefit code is automatically selected on a claim detail where multiple benefit codes all match with equivalent payment details nullable: true flex_Claim_After_Grace_Period_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when a Flex Claim is submitted after the Grace period nullable: true flex_Claim_After_Submit_Period_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when a Flex Claim is submitted after the Submission period nullable: true flex_Claim_Funds_Exhausted_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when the Flex Claim has exceeded the balance nullable: true force_Call_Track_Note: type: boolean description: 'Not used in system configuration. Used on external and/or custom procedures. Note: This field is marked as NOT NULL in the database and therefore required by the API.' force_Claim_Rec_Date: type: boolean description: 'If selected, the claim must have a Received_Date, ELSE it will Error Note: This field is marked as NOT NULL in the database and therefore required by the API.' force_Claim_Sub_ID: maxLength: 1 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true force_Latest_Enrollment: type: boolean description: 'Use Latest Enrollment Note: This field is marked as NOT NULL in the database and therefore required by the API.' force_Leading_Zero_On_Rev_Code: type: boolean description: 'If selected and the procedure code is only 3 length, add a zero to verify the procedure code Note: This field is marked as NOT NULL in the database and therefore required by the API.' full_Backout_On_Void_Distribution: type: boolean description: 'When selected, Add all the backout Distribution records when voiding a check Note: This field is marked as NOT NULL in the database and therefore required by the API.' full_Month_Billing: maxLength: 1 minLength: 1 type: string description: 'Not used in system configuration. Used on external and/or custom procedures. Note: This field is marked as NOT NULL in the database and therefore required by the API.' generate_Comm_Date: type: string description: Used to stop other users from generating invoices while another user is generating commissions. format: date-time nullable: true generate_Comm_User: maxLength: 16 type: string description: Used to stop other users from generating invoices while another user is generating commissions. nullable: true generate_Inv_Date: type: string description: Used to stop other users from generating invoices while another user is generating invoices format: date-time nullable: true generate_Inv_User: maxLength: 16 type: string description: Used to stop other users from generating invoices while another user is generating invoices nullable: true generate_Negative_Inv: type: boolean description: 'Check this checkbox to allow for a negative invoice to create. This will also allow a $0 invoice to create. Note: This field is marked as NOT NULL in the database and therefore required by the API.' generate_PremDist_After: type: string description: 'When Generating Invoices, look for distributions after this date' format: date-time nullable: true global_CMU_ID: maxLength: 16 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true grace_Logins: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true group_Length: type: number description: Not used in system configuration. Used on external and/or custom procedures. format: double nullable: true iD_Card_Location: maxLength: 255 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true ivR_CS_Country_Code: maxLength: 8 type: string description: Country Code for IVR or Customer Service number. nullable: true ivR_CS_Phone_Number: maxLength: 20 type: string description: IVR or Customer Service number of the Client. nullable: true ignore_Care_Management_Hierarchy_Fg: type: boolean description: 'Overrides Case Manager Hierarchy and allows the assigning of cases up or down Note: This field is marked as NOT NULL in the database and therefore required by the API.' ignore_Claim_Funding_Status_Change_Msg: type: boolean description: 'This is a flag indicating that when changing a claims status in Claim Funding, no message will display warning the user of the existing status. Note: This field is marked as NOT NULL in the database and therefore required by the API.' inactive_Payee_Ex_Code: maxLength: 6 type: string description: When a claim has a Provider using a Payee that is marked as inactive nullable: true include_Invalid_Enrollments: type: boolean description: 'Not used in system configuration. Used on external and/or custom procedures. Note: This field is marked as NOT NULL in the database and therefore required by the API.' inv_Grace_Period: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true inv_Grace_Period_Type: maxLength: 1 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true invalid_Diag_Ex_Code: maxLength: 6 type: string description: This Ex Code is used when the Diagnosis Code is invalid nullable: true invalid_Proc_Ex_Code: maxLength: 6 type: string description: This Ex Code is used when the Procedure Code is invalid nullable: true invoice_Close_Adj_Reason: type: integer description: Default reason for Invoice Closed format: int32 nullable: true invoice_Enrolled_By: type: integer description: 'Date used when configuring Enrolled By Date for Invoices Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 invoice_Enrolled_Thru: type: integer description: Date used when configuring Enrolled Thru Date for Invoices format: int32 nullable: true invoice_Grace_Ex_Code: maxLength: 6 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true invoice_Grace_Period: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true invoice_Remit_Account_Key: type: integer description: Default Invoice Remit Account format: int32 nullable: true invoice_Remit_Address1: maxLength: 128 type: string description: Default Invoice Remit Address nullable: true invoice_Remit_Address2: maxLength: 128 type: string description: Default Invoice Remit Address2 nullable: true invoice_Remit_City: maxLength: 32 type: string description: Default Invoice Remit City nullable: true invoice_Remit_Country_Code: maxLength: 8 type: string description: Default Invoice Remit Country Code nullable: true invoice_Remit_Country_ID: maxLength: 8 type: string description: Default Invoice Remit Country nullable: true invoice_Remit_Name: maxLength: 128 type: string description: Default Invoice Remit Name nullable: true invoice_Remit_Phone_Number: maxLength: 32 type: string description: Default Invoice Remit Phone Number nullable: true invoice_Remit_State: maxLength: 2 type: string description: Default Invoice Remit State nullable: true invoice_Remit_Zip_Code: maxLength: 32 type: string description: Default Invoice Remit Zip Code nullable: true lag_Time: type: integer description: 'Not used in system configuration. Used on external and/or custom procedures. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 last_Age_Disenroll: type: string description: Not used in system configuration. Used on external and/or custom procedures. format: date-time nullable: true last_Authorization: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true last_Billing: type: string description: Not used in system configuration. Used on external and/or custom procedures. format: date-time nullable: true last_Case_Number: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true last_Check_Batch: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true last_Claim_Number: type: number description: Used to determine the next Claim Number format: double nullable: true last_Day_Worked_Range: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true last_Encounter: type: number description: Not used in system configuration. Used on external and/or custom procedures. format: double nullable: true last_Invoice: type: number description: 'Filled out after an Invoice is generated, likely used for reporting or as a reference' format: double nullable: true lock_Auth_Review: type: boolean description: 'If selected, only the user that created the Auth Review can update the Auth Review Note: This field is marked as NOT NULL in the database and therefore required by the API.' lock_Auth_Review_All: type: boolean description: 'When this is checked, Auth Reviews cannot be updated or modified by anyone. They can still be added. Note: This field is marked as NOT NULL in the database and therefore required by the API.' log_BaseLoad_Call: type: boolean description: 'Flag that enables the logging of calls to Baseload for provider information Note: This field is marked as NOT NULL in the database and therefore required by the API.' logo_File: maxLength: 128 type: string description: Stores the file location for logos. nullable: true long_State_Names: maxLength: 1 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true mail_AuthMode: type: integer description: 'Client''s e-mail server AuthMode (Not sure, just passed in as general settings)' format: int32 nullable: true mail_Password: maxLength: 64 type: string description: Client's e-mail server Password nullable: true mail_Port: type: integer description: Client's e-mail server Port format: int32 nullable: true mail_Server: maxLength: 128 type: string description: Client's e-mail server nullable: true mail_Use_SSL: type: boolean description: 'Client''s e-mail server SSL setting Note: This field is marked as NOT NULL in the database and therefore required by the API.' mail_User: maxLength: 64 type: string description: Client's e-mail server User Name nullable: true medicare_On_Benefit: maxLength: 1 minLength: 1 type: string description: 'Not used in system configuration. Used on external and/or custom procedures. Note: This field is marked as NOT NULL in the database and therefore required by the API.' member_Address_DOB_Not_Reqd: type: boolean description: 'This flag indicates if a full address and date of birth are not required when creating a new member Note: This field is marked as NOT NULL in the database and therefore required by the API.' member_Match_By_Name_BirthDate: type: boolean description: 'When selected, adjudication will attempt to match a patient on their First Name, Last Name and Birth Date Note: This field is marked as NOT NULL in the database and therefore required by the API.' modifier_Not_Eff_Ex_Code: maxLength: 8 type: string description: This Denial Ex Code will deny a claim when the modifier entered is not listed as active on the modifier table. nullable: true multiple_Auth_Ex_Code: maxLength: 6 type: string description: 'If filled out and there are multiple Auths that are valid, insert the Ex Code' nullable: true name: maxLength: 60 type: string description: Name of the Company. nullable: true network_Does_Not_Match_Repriced_Network_Ex_Code: maxLength: 6 type: string description: 'When the Network ID on the claim does not match what the system would have selected, throw this ex code' nullable: true new_Member_Reason: type: integer description: Reason for the new Member. format: int32 nullable: true note_Attachment_DB: type: boolean description: 'If selected, Note Attachments will be saved to the Database instead of in a local file location Note: This field is marked as NOT NULL in the database and therefore required by the API.' note_Attachment_Local_Default: maxLength: 255 type: string description: 'Indicates the local location for note attachments. When a note attachment is opened, it will make a copy from the remote location to the local location before opening the file.' nullable: true note_Attachment_Remote_Default: maxLength: 255 type: string description: Indicates the remote location where note attachments will be saved. A network location should be populated at this location. nullable: true ooP_Max_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when the claim exceeds the OOP Maximum nullable: true ooP_Max_Ex_Code_Member: maxLength: 8 type: string description: This Informational Ex Code will be applied to a claim when the Member level out of pocket has been exceeded. nullable: true out_Of_Net_Ex_Code: maxLength: 8 type: string description: This Informational Ex Code will be applied to all claims processed as out of network. nullable: true overpayment_Deduction_Type: maxLength: 8 type: string description: Override's the default Deduction Type of 502 nullable: true pcP_Only_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when a Benefit is marked PCP Only and the Member does not have a valid PCP nullable: true partial_Cap: type: boolean description: 'Not used in system configuration. Used on external and/or custom procedures. Note: This field is marked as NOT NULL in the database and therefore required by the API.' password_Expiration: type: integer description: Sets the number of days before password expiration. format: int32 nullable: true password_Minimum: type: integer description: Sets the minimum length required for application passwords. format: int32 nullable: true pay_Period_Start_Date: type: string description: This date is used to calculate the Bill From and Bill Thru dates for invoices using the Calendar Payroll type of Billing Cycle. format: date-time nullable: true payment_Proration: type: boolean description: 'Whether or not invoices will be prorated Note: This field is marked as NOT NULL in the database and therefore required by the API.' phone_Country_Code: maxLength: 8 type: string description: Country Code for the phone number of the Subscriber. nullable: true phone_Format: maxLength: 20 type: string description: Phone format used when saving reports as formatted Excel nullable: true phone_Number: maxLength: 20 type: string description: Phone number of the Client. nullable: true place_Code_Not_Setup_Ex_Code: maxLength: 6 type: string description: 'This Ex Code is used when a Place Code is not valid for an Auth, Benefit, Co Ins or Co Pay' nullable: true planBenefit_Override_Network_ID: maxLength: 10 type: string description: 'When Always Pay In Network is checked, if this is filled out and the claim is currently out of network, change the Network ID to this value.' nullable: true plan_Length: type: number description: Not used in system configuration. Used on external and/or custom procedures. format: double nullable: true policy_Forfeiture_Grace_Period: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true policy_Forfeiture_Grace_Period_Type: maxLength: 1 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true premium_Proration: type: boolean description: 'This flag denotes whether or not Premiums will be prorated when a Member Disenrolls Note: This field is marked as NOT NULL in the database and therefore required by the API.' prevent_Suspense_Release_By_Process_User: type: boolean description: 'Flag to prevent the same user that processed a claim from releasing it from Claim Suspended status. Note: This field is marked as NOT NULL in the database and therefore required by the API.' primary_Account_Key: type: integer description: This defines the primary bank account. format: int32 nullable: true process_Auths_When_Pended: type: boolean description: 'When this flag is set to yes, adjudication will process Auths on Pended claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.' process_Auto_COB: type: boolean description: 'Identifies that the check run process will now create Auto-COB claims if the Secondary member information is configured on a MemberInsruance record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' processing_Mode: maxLength: 1 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true prof_ATP_Paid_Date_Type: maxLength: 32 type: string description: Holds the selected setting for ATP Paid Date on Professional Claims (Standard or by Processed Date) nullable: true prosthesis_Tooth_Ex_Code: maxLength: 8 type: string description: Ex Code to set when the member has used a Prosthesis Tooth nullable: true protect_Alternate_ID: type: boolean description: 'This flag indicates the alternate ID on the member update screen cannot be changed Note: This field is marked as NOT NULL in the database and therefore required by the API.' provider_Auth_Exempt_Procedure_Ex_Code: maxLength: 8 type: string description: 'If a provider is exempt from Authorizations, throw this ex code' nullable: true provider_Not_Active_Auth_Code: maxLength: 8 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true pulled_Tooth_Ex_Code: maxLength: 8 type: string description: This pend code will be applied when the tooth number on the claim is found to have been previously pulled. nullable: true qpA_Method_1_Ex_Code: maxLength: 6 type: string description: Ex Code to be applied to claims that use QPA Method 1 nullable: true qpA_Method_2_Ex_Code: maxLength: 6 type: string description: Ex Code to be applied to claims that use QPA Method 2 nullable: true rX_ATP_Paid_Date_Type: maxLength: 32 type: string description: 'Default value for an RX Claim''s Paid Date: Service Date, Fill Date or Prescription Date' nullable: true reduced_Paid_Up_Default: type: integer description: Default Issue Duratoin Value for RPU Type format: int32 nullable: true reins_Split_Claim: type: boolean description: 'Not used in system configuration. Used on external and/or custom procedures. Note: This field is marked as NOT NULL in the database and therefore required by the API.' repetitive_Payment: type: boolean description: 'If set to yes, bring up the list of Repetitive Payments on a timer' nullable: true repriced_Line: maxLength: 64 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true request_ID_Card_Prompt_Enrollment: type: boolean description: 'If checked, when the user updates a member record, prompt the user if they want to request a new ID Card. Note: This field is marked as NOT NULL in the database and therefore required by the API.' request_Provider_Email: maxLength: 255 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true request_Reassess_Email: maxLength: 255 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true restrict_NPI_Federal_ID: type: boolean description: 'This flag indicates the NPI and Federal ID fields on a Provider record have length restrictions of 10/9 characters respectively Note: This field is marked as NOT NULL in the database and therefore required by the API.' return_To_Work_Range: type: integer description: Defined Return to Work Range for a disability claim format: int32 nullable: true scanned_Images_Folder: maxLength: 255 type: string description: Indicates the file location where scanned images are kept. nullable: true set_Paid_Through: type: boolean description: 'If selected, set the Paid Through Date once an invoice is closed Note: This field is marked as NOT NULL in the database and therefore required by the API.' single_Refund_Check_Batch: type: boolean description: 'If selected put all refunds into the same Check Batch Note: This field is marked as NOT NULL in the database and therefore required by the API.' state: maxLength: 2 type: string description: State of the Company's address. nullable: true subscriber_ID_Format: maxLength: 20 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true subscriber_Length: type: number description: Not used in system configuration. Used on external and/or custom procedures. format: double nullable: true system_Idle: type: integer description: 'Enter the time, in seconds, that will be allowed to elapse before the application closes.' format: int32 nullable: true tax_Control_Location: maxLength: 255 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true tax_On_Adjudcation_Date_Fg: type: boolean description: 'Whether Tax is calculated on date of adjudication or Service Date of claim Note: This field is marked as NOT NULL in the database and therefore required by the API.' temporary_Save_Criteria_Count: type: integer description: How many rows in the criteria table to temporarily save format: int32 nullable: true termed_Provider_Ex_Code: maxLength: 6 type: string description: This Ex Code is used when the Provider's Term Date is before the Service Date nullable: true toll_Free_Country_Code: maxLength: 8 type: string description: Country Code for the toll free phone number of the Client. nullable: true toll_Free_Phone_Number: maxLength: 20 type: string description: Toll free phone number of the Client. nullable: true tooth_Activity_Ex_Code: maxLength: 8 type: string description: This pend code will be applied when the tooth number on the claim is found to have previous tooth activity. nullable: true tooth_Chart_Type: maxLength: 8 type: string description: Choose the applicable tooth chart for the application. nullable: true uB92_ATP_Paid_Date_Type: maxLength: 32 type: string description: Holds the selected setting for ATP Paid Date on Institutional Claims (Standard or by Processed Date) nullable: true uC_Price_Used_Ex_Code: maxLength: 8 type: string description: This Ex Code is used when Usual and Customary is used. nullable: true uC_Unit_Mulitply: type: boolean description: 'Whether or not the Plan Price is multiplied by number of units for Usual and Customary Note: This field is marked as NOT NULL in the database and therefore required by the API.' unassigned_Provider: maxLength: 8 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true useGreaterUserAmountLimit_Fg: type: boolean description: 'Whether or not to validate User Amount Limits for Payable or Total Payable Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Auth_Over_Unit_Split: type: boolean description: 'Whether or not to split Authorizations Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Change_Data_Capture: type: boolean description: 'No longer used in the system Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Commission_Cluster_Hierarchy: type: boolean description: 'Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Currency: type: boolean description: 'Whether or not to use the Default Currency Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Disability_From_Date: type: boolean description: 'When selected, Disability Claims will be verified to be within the payable date range and if not, the claim will not process. Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Expanded_Notes: type: boolean description: 'Fills out NoteReference among other things for Notes Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_First_Match_Pricing: type: boolean description: 'Use first Fee Schedule match found Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Other_Name: maxLength: 1 type: string description: Not used in system configuration. Used on external and/or custom procedures. nullable: true use_Primary_Diag_Match: type: boolean description: 'If selected, during Age Restrictions, only look at the left most Diag Pointer on a Claim Line Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Primary_Diag_Match_Capitation: type: boolean description: 'When determining Include Excludes for Capitation Diagnosis Codes, if set to yes, only look at the first pointer. Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Salary: type: boolean description: 'Not used in system configuration. Used on external and/or custom procedures. Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Tax_Control: type: boolean description: 'Whether or not to use the Tax Control object rather than adjudication Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_VBASoftware_2: type: boolean description: 'Notes that this client is no longer utilizing Legacy VBASoftware. Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_VBAdjudicate_2: type: boolean description: 'This is a flag indicating if this database (client) is utilizing new serverless adjudication. This flag will drive old adjudication to not pickup claims for example, or tell VBASoftware that the "Adjudicate" button on claims goes a different route. Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Zip_Code_Auto_Populate: type: boolean description: 'Whether or not Zip Code with auto poulate city/state based on Zip Code Note: This field is marked as NOT NULL in the database and therefore required by the API.' vbaDataIntegration: type: boolean description: 'Whether or not VBADataintegration is on or not Note: This field is marked as NOT NULL in the database and therefore required by the API.' vbaDataIntegration_DBMS: maxLength: 128 type: string description: DBMS setup information for VBA Data Integration nullable: true vbaDataIntegration_DBParm: maxLength: 1024 type: string description: DBMS setup information for VBA Data Integration nullable: true vbaDataIntegration_Database: maxLength: 128 type: string description: Database setup information for VBA Data Integration nullable: true vbaDataIntegration_Server: maxLength: 128 type: string description: Server setup information for VBA Data Integration nullable: true vbaGateway: type: boolean description: 'Whether or not this is a Gateway client Note: This field is marked as NOT NULL in the database and therefore required by the API.' vbaGateway_DBMS: maxLength: 128 type: string description: Gateway's DBMS nullable: true vbaGateway_DBParm: maxLength: 1024 type: string description: Gateway's Database Parameters nullable: true vbaGateway_Database: maxLength: 128 type: string description: Gateway's Database nullable: true vbaGateway_SFTP_Host: maxLength: 256 type: string description: Gateway's SFTP Host nullable: true vbaGateway_SFTP_LogFile: maxLength: 256 type: string description: Gateway's SFTP LogFile nullable: true vbaGateway_SFTP_MLST: type: boolean description: 'Gateway''s SFTP MLST Note: This field is marked as NOT NULL in the database and therefore required by the API.' vbaGateway_SFTP_Passive: type: boolean description: 'Gateway''s SFTP Passive Note: This field is marked as NOT NULL in the database and therefore required by the API.' vbaGateway_SFTP_Password: maxLength: 256 type: string description: Gateway's SFTP Password nullable: true vbaGateway_SFTP_Port: type: integer description: Gateway's SFTP Port format: int32 nullable: true vbaGateway_SFTP_Protocol: type: integer description: Gateway's SFTP Protocol format: int32 nullable: true vbaGateway_SFTP_User: maxLength: 64 type: string description: Gateway's SFTP User ID nullable: true vbaGateway_Server: maxLength: 128 type: string description: Gateway's Server nullable: true vbapI_Adjudicate_Client_Code: maxLength: 32 type: string description: System Configuration Values used by VBA Engineers. nullable: true vbapI_Adjudicate_Client_ID: maxLength: 32 type: string description: System Configuration Values used by VBA Engineers. nullable: true vbapI_Adjudicate_Database: maxLength: 64 type: string description: System Configuration Values used by VBA Engineers. nullable: true vbapI_ClaimQueue_URL: maxLength: 1024 type: string description: For internal Developer use only. nullable: true vbapI_Client_Code: maxLength: 32 type: string description: For internal Developer use only. nullable: true vbapI_Field_Masking_Enabled: type: boolean description: 'Identifies if Field Masking is enabled. This is a VBAPI setting so does not impact Legacy VBASoftware. Note: This field is marked as NOT NULL in the database and therefore required by the API.' vbapI_IP_Whitelist: type: boolean description: 'Indicates if the client has IP Whitelisting enabled for accessing APIs. If enabled, IP Addresses will be added to the IPWhitelist table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' vbaReport_Event_Timer: type: integer description: Timer for kicking off VBA Report to see if an Event is ready to be Processed format: int32 nullable: true vbaReport_Mail_AuthMode: type: integer description: 'Client''s Process Automation Auth Mode (Not sure, just passed in as general settings)' format: int32 nullable: true vbaReport_Mail_Password: maxLength: 64 type: string description: Client's Process Automation Password nullable: true vbaReport_Mail_Port: type: integer description: Client's Process Automation server Port format: int32 nullable: true vbaReport_Mail_Server: maxLength: 128 type: string description: Client's Process Automation server nullable: true vbaReport_Mail_Use_SSL: type: boolean description: 'Client''s Process Automation SSL Setting Note: This field is marked as NOT NULL in the database and therefore required by the API.' vbaReport_Mail_User: maxLength: 64 type: string description: Client's Process Automation User Name nullable: true vbaReport_SO_Count: type: integer description: 'Value retrieved in VbA Report, nothing done with it' format: int32 nullable: true vbaReport_Series_Timer: type: integer description: Timer for kicking off VBA Report to see if a Series is ready to be Processed format: int32 nullable: true vbaReport_Status: maxLength: 32 type: string description: 'Current Status of VBAReport (Pause, Stop, Running)' nullable: true vbaReport_Timer: type: integer description: Timer for kicking off VBA Report to see if a Report is ready to be Processed format: int32 nullable: true vbAdjudicate_SO_Count: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true vbAdjudicate_Status: maxLength: 32 type: string description: 'Current Status of Adjudication (Pause, Stop, Running)' nullable: true vbAdjudicate_Timer: type: integer description: Not used in system configuration. Used on external and/or custom procedures. format: int32 nullable: true validate_Federal_ID_On_Auth: type: boolean description: 'Whether or not to validate Authorizations based on Federal ID Note: This field is marked as NOT NULL in the database and therefore required by the API.' validate_Provider_On_Auth: type: boolean description: 'If set to yes, the Provider must match on the Claim with the Auth Note: This field is marked as NOT NULL in the database and therefore required by the API.' void_Backout_Use_Current_Date: type: boolean description: 'When used, a Void backout will use today''s date instead of processed date Note: This field is marked as NOT NULL in the database and therefore required by the API.' volume_Max_Met_Ex_Code: maxLength: 6 type: string description: This Ex Code is used when the Maximum Volume is used to lower the Volume to maximum nullable: true volume_Min_Met_Ex_Code: maxLength: 6 type: string description: This Ex Code is used when the Minimum Volume is used to raise the Volume to minimum nullable: true workflow_Execute_Count: type: integer description: This indicates how many workflows will be executed per iteration from VBAdjudicateGovernor format: int32 nullable: true zelis_EOBCode_Not_Found_Ex_Code: maxLength: 6 type: string description: Default EOB Code not found ex code used when one is not sent for Zelis nullable: true zelis_EditCode_Not_Found_Ex_Code: maxLength: 6 type: string description: Default Edit Code not found ex code used when one is not sent for Zelis nullable: true zelis_In_Network_Ex_Code: maxLength: 6 type: string description: 'When the Zelis In Network Ex Code is set, and the Ex Code is on the claim and sent to Zelis, the claim will always be sent as "In Network" regardless if the claim is In or Out of Network' nullable: true zelis_Login: maxLength: 128 type: string description: Login information for Zelis Repricing API nullable: true zelis_Password: maxLength: 128 type: string description: Password information for Zelis Repricing API nullable: true zelis_Poll: type: boolean description: 'Whether or not the system should be polling Zelis Repricing Note: This field is marked as NOT NULL in the database and therefore required by the API.' zelis_Poll_Testing: type: boolean description: 'Indicates if Zelis Polling is "In Testing". When "In Testing", polling activity will fire for the first call to Zelis only, so that Zelis has the claim, then not make any additional polling entries until the client indicates the test is complete. Disabling this will then proceed to make new polling entries on claims in QUEUED and INPROCESS as normal. Note: This field is marked as NOT NULL in the database and therefore required by the API.' zelis_URL: maxLength: 1024 type: string description: URL used to connect to the Zelis Cost Containment System nullable: true zip_Code: maxLength: 32 type: string description: Zip code of the Client. nullable: true use_VBAdjudicate_Benefit_Matching: type: boolean display_Member_Primary_Network: type: boolean additionalProperties: false CompanyDataListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CompanyData' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CompanyDataVBAResponse: type: object properties: data: $ref: '#/components/schemas/CompanyData' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Contact: required: - contact_Key type: object properties: contact_Key: type: integer format: int32 address: maxLength: 128 type: string nullable: true address_2: maxLength: 128 type: string nullable: true city: maxLength: 64 type: string nullable: true contact_Category: maxLength: 16 type: string nullable: true contact_Image: maxLength: 128 type: string nullable: true contact_Status: maxLength: 16 type: string nullable: true contact_Type: maxLength: 16 type: string nullable: true contact_Web_Address: maxLength: 256 type: string nullable: true country_ID: maxLength: 8 type: string nullable: true county_Code: maxLength: 8 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true first_Name: maxLength: 32 type: string nullable: true last_Name: maxLength: 32 type: string nullable: true middle_Name: maxLength: 32 type: string nullable: true org_Name: maxLength: 256 type: string nullable: true qR_Code_File: maxLength: 128 type: string nullable: true state: maxLength: 2 type: string nullable: true title: maxLength: 128 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true zip_Code: maxLength: 16 type: string nullable: true additionalProperties: false ContactAssign: required: - assign_Type - contact_Key - contactAssign_Key type: object properties: contactAssign_Key: type: integer format: int32 assign_Priority: type: integer format: int32 nullable: true assign_Type: maxLength: 16 minLength: 1 type: string contact_Key: type: integer format: int32 effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true key_Column1: maxLength: 128 type: string nullable: true key_Column2: maxLength: 128 type: string nullable: true key_Column3: maxLength: 128 type: string nullable: true key_Column4: maxLength: 128 type: string nullable: true key_Column5: maxLength: 128 type: string nullable: true key_DataType1: maxLength: 32 type: string nullable: true key_DataType2: maxLength: 32 type: string nullable: true key_DataType3: maxLength: 32 type: string nullable: true key_DataType4: maxLength: 32 type: string nullable: true key_DataType5: maxLength: 32 type: string nullable: true key_Value1: maxLength: 128 type: string nullable: true key_Value2: maxLength: 128 type: string nullable: true key_Value3: maxLength: 128 type: string nullable: true key_Value4: maxLength: 128 type: string nullable: true key_Value5: maxLength: 128 type: string nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ContactAssignListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ContactAssign' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContactAssignVBAResponse: type: object properties: data: $ref: '#/components/schemas/ContactAssign' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContactCategory: required: - contact_Category type: object properties: contact_Category: maxLength: 16 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ContactCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ContactCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContactCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/ContactCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContactEmail: required: - contact_Key - contactEmail_Key - email_Type type: object properties: contactEmail_Key: type: integer format: int32 contact_Key: type: integer format: int32 email_Address: maxLength: 256 type: string nullable: true email_Type: maxLength: 16 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ContactEmailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ContactEmail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContactEmailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ContactEmail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContactListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Contact' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContactMapping: required: - child_Contact_Key - parent_Contact_Key type: object properties: parent_Contact_Key: type: integer format: int32 child_Contact_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ContactMappingListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ContactMapping' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContactMappingVBAResponse: type: object properties: data: $ref: '#/components/schemas/ContactMapping' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContactPhone: required: - contact_Key - contactPhone_Key - phone_Type type: object properties: contactPhone_Key: type: integer description: 'ID of the contact phone number. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 contact_Key: type: integer description: 'ID of the contact. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true phone_Country_Code: maxLength: 8 type: string description: Country code of the contact's phone number. nullable: true phone_Number: maxLength: 32 type: string description: Phone number of the contact. nullable: true phone_Type: maxLength: 16 minLength: 1 type: string description: Identifies the type of phone number. update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ContactPhoneListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ContactPhone' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContactPhoneVBAResponse: type: object properties: data: $ref: '#/components/schemas/ContactPhone' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContactStatus: required: - contact_Status type: object properties: contact_Status: maxLength: 16 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ContactStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ContactStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContactStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ContactStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContactVBAResponse: type: object properties: data: $ref: '#/components/schemas/Contact' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContributionSchedule: required: - contribution_Schedule type: object properties: contribution_Schedule: maxLength: 32 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true schedule_Frequency: type: integer format: int32 nullable: true schedule_Type: maxLength: 1 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ContributionScheduleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ContributionSchedule' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ContributionScheduleVBAResponse: type: object properties: data: $ref: '#/components/schemas/ContributionSchedule' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CopyGroupDivision: required: - destinationDivisionID - destinationGroupID - groupID - sourceDivisionID type: object properties: groupID: minLength: 1 type: string description: The owning Group sourceDivisionID: minLength: 1 type: string description: The division from which values will be copied. destinationGroupID: minLength: 1 type: string description: The Destination Group ID destinationDivisionID: minLength: 1 type: string description: Name of the new divion copyContracts: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true copyPlans: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true copyRiders: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true copyAdditional: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true copyClassOptions: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true copyCommissions: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true copyDisabilityOptions: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true copyNetworksTiers: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true copyPlanYears: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true copyPremiums: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true copySelfAdmin: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true copyStudentAge: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true copyVolumeDetails: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true copyIDCodes: type: string description: Flag indicating to copy this field or not. Default is false. nullable: true additionalProperties: false CostContainContext4CaseIndex: required: - caseIndex type: object properties: caseIndex: maxLength: 8 minLength: 1 type: string description: maxLength: 2048 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CostContainContext4CaseIndexListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainContext4CaseIndex' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4CaseIndexVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainContext4CaseIndex' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4Category: required: - category type: object properties: category: maxLength: 8 minLength: 1 type: string description: maxLength: 2048 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CostContainContext4CategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainContext4Category' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4CategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainContext4Category' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4DefaultAction: required: - defaultAction type: object properties: defaultAction: maxLength: 8 minLength: 1 type: string description: maxLength: 2048 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CostContainContext4DefaultActionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainContext4DefaultAction' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4DefaultActionVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainContext4DefaultAction' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4Error: required: - error_Key type: object properties: error_Key: type: integer format: int32 batch_Claim: type: integer format: int32 nullable: true batch_Number: type: integer format: int32 nullable: true caseIndex: maxLength: 8 type: string nullable: true category: maxLength: 8 type: string nullable: true defaultAction: maxLength: 8 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true errorDescription: type: string nullable: true errorNumber: maxLength: 16 type: string nullable: true itsValue: maxLength: 64 type: string nullable: true line: maxLength: 8 type: string nullable: true messageType: maxLength: 8 type: string nullable: true offendingCode: maxLength: 32 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CostContainContext4ErrorListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainContext4Error' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4ErrorVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainContext4Error' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4ExCode: required: - exCode_Key type: object properties: exCode_Key: type: integer format: int32 caseIndex: maxLength: 8 type: string nullable: true category: maxLength: 8 type: string nullable: true defaultAction: maxLength: 8 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true errorNumber_From: maxLength: 16 type: string nullable: true errorNumber_Thru: maxLength: 16 type: string nullable: true ex_Code: maxLength: 6 type: string nullable: true messageType: maxLength: 8 type: string nullable: true offendingCode: maxLength: 32 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CostContainContext4ExCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainContext4ExCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4ExCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainContext4ExCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4MessageType: required: - messageType type: object properties: messageType: maxLength: 8 minLength: 1 type: string description: maxLength: 2048 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CostContainContext4MessageTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainContext4MessageType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4MessageTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainContext4MessageType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4Option: required: - context_Option - exclude - from_Value - option_Key - plan_ID type: object properties: option_Key: type: integer format: int32 context_Option: maxLength: 50 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true exclude: type: boolean from_Value: maxLength: 128 minLength: 1 type: string plan_ID: maxLength: 20 minLength: 1 type: string thru_Value: maxLength: 128 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CostContainContext4OptionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainContext4Option' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4OptionPricing: required: - option_Key - plan_ID type: object properties: option_Key: type: integer format: int32 claim_Type: maxLength: 20 type: string nullable: true context4_ClmUcrPct: type: integer format: int32 nullable: true context4_ClmUcrPct_OON: type: integer format: int32 nullable: true context4_MedicarePct: type: integer format: int32 nullable: true context4_MedicarePct_OON: type: integer format: int32 nullable: true context4_PctOfChg: type: integer format: int32 nullable: true context4_PctOfChg_OON: type: integer format: int32 nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true plan_ID: maxLength: 20 minLength: 1 type: string provider_Type: maxLength: 10 type: string nullable: true specialty_Code: maxLength: 10 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CostContainContext4OptionPricingListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainContext4OptionPricing' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4OptionPricingVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainContext4OptionPricing' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainContext4OptionVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainContext4Option' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainZelisClaimDetailReprice: required: - adjustment_Seq - batch_Claim - batch_Number - claim_Seq type: object properties: batch_Number: type: integer format: int32 batch_Claim: type: integer format: int32 claim_Seq: maxLength: 2 minLength: 1 type: string adjustment_Seq: maxLength: 3 minLength: 1 type: string amountDue: type: number format: double nullable: true appliedService: maxLength: 32 type: string nullable: true editCode: maxLength: 32 type: string nullable: true editDescription: maxLength: 512 type: string nullable: true randC: type: number format: double nullable: true savings: type: number format: double nullable: true zelisFees: type: number format: double nullable: true additionalProperties: false CostContainZelisClaimDetailRepriceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainZelisClaimDetailReprice' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainZelisClaimDetailRepriceVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainZelisClaimDetailReprice' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainZelisClaimReprice: required: - batch_Claim - batch_Number - transactionID type: object properties: batch_Number: type: integer format: int32 batch_Claim: type: integer format: int32 amountDue: type: number format: double nullable: true appliedService: maxLength: 32 type: string nullable: true customEOPLanguage: maxLength: 512 type: string nullable: true dueDateFrom: type: string format: date-time nullable: true dueDateTo: type: string format: date-time nullable: true eopLanguageCode: maxLength: 32 type: string nullable: true savings: type: number format: double nullable: true transactionID: maxLength: 64 minLength: 1 type: string zelisClaimID: type: integer format: int32 nullable: true zelisFees: type: number format: double nullable: true additionalProperties: false CostContainZelisClaimRepriceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainZelisClaimReprice' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainZelisClaimRepriceVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainZelisClaimReprice' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainZelisEOBCode: required: - eobCode type: object properties: eobCode: maxLength: 32 minLength: 1 type: string eobLanguage: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true ex_Code: maxLength: 6 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CostContainZelisEOBCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainZelisEOBCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainZelisEOBCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainZelisEOBCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainZelisEditCode: required: - editCode type: object properties: editCode: maxLength: 32 minLength: 1 type: string eobLanguage: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true ex_Code: maxLength: 6 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CostContainZelisEditCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainZelisEditCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainZelisEditCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainZelisEditCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainZelisExCode: required: - ex_Code - in_Network - oon type: object properties: ex_Code: maxLength: 6 minLength: 1 type: string description: An Ex Code that is being used for Zelis entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true in_Network: type: boolean description: 'When the Ex Code is present on the claim, when this is sent to Zelis, send it as In Network Note: This field is marked as NOT NULL in the database and therefore required by the API.' oon: type: boolean description: 'When the Ex Code is present on the claim, when this is sent to Zelis, send it as Out of Network Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CostContainZelisExCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainZelisExCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainZelisExCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainZelisExCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainZelisPoll: required: - batch_Claim - batch_Number - costContainZelisPoll_Key - transactionID type: object properties: costContainZelisPoll_Key: type: integer format: int32 batch_Claim: type: integer format: int32 batch_Number: type: integer format: int32 claimQueueProcessor_Key: type: integer format: int32 nullable: true errorDescription: type: string nullable: true poll_Date: type: string format: date-time nullable: true status: maxLength: 32 type: string nullable: true transactionID: maxLength: 64 minLength: 1 type: string zelis_Result: type: string nullable: true additionalProperties: false CostContainZelisPollListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CostContainZelisPoll' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CostContainZelisPollVBAResponse: type: object properties: data: $ref: '#/components/schemas/CostContainZelisPoll' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Country: required: - country_ID type: object properties: country_ID: maxLength: 8 minLength: 1 type: string description: ID of the country. entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true long_Name: maxLength: 128 type: string description: Full name of the country. nullable: true short_Name: maxLength: 64 type: string description: Abbreviated name of the country. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CountryDialingCode: required: - country_Code - country_ID type: object properties: country_ID: maxLength: 8 minLength: 1 type: string country_Code: maxLength: 8 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false CountryDialingCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CountryDialingCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CountryDialingCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CountryDialingCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CountryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Country' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CountryVBAResponse: type: object properties: data: $ref: '#/components/schemas/Country' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false County: required: - county_Code type: object properties: county_Code: maxLength: 8 minLength: 1 type: string description: ID of the county. county_Name: maxLength: 64 type: string description: Name for the county. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true state: maxLength: 2 type: string description: State that the county is within. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CountyListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/County' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CountyVBAResponse: type: object properties: data: $ref: '#/components/schemas/County' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CoverageType: required: - coverage_Type type: object properties: coverage_Type: maxLength: 32 minLength: 1 type: string description: Name for the coverage type. description: maxLength: 512 type: string description: Description of the coverage type. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CoverageTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CoverageType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CoverageTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CoverageType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredAmount: required: - credAmount_Key type: object properties: credAmount_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: A description of the associated amount units. nullable: true display: maxLength: 128 type: string description: Display name of the amount units that will be availble for credentialing services. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredAmountListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredAmount' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredAmountVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredAmount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredAttestationMethod: required: - credAttestationMethod_Key type: object properties: credAttestationMethod_Key: type: integer description: 'Identifies the method by which attestation question was administered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: A description area used to provider more detail about the attestation method. nullable: true display: maxLength: 128 type: string description: Identifies the display name of the attestation method. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredAttestationMethodListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredAttestationMethod' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredAttestationMethodVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredAttestationMethod' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredAttestationQuestion: required: - credAttestationQuestion_Key - dateAnswer - numericAnswer - textAnswer - yesNoAnswer type: object properties: credAttestationQuestion_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 dateAnswer: type: boolean description: 'Identifies that the question requires a date answer. Note: This field is marked as NOT NULL in the database and therefore required by the API.' default_Method_Key: type: integer description: Specifies the default method that will be used to administer the question. format: int32 nullable: true default_Source_Key: type: integer description: Specifies the default source of the question. format: int32 nullable: true default_Type_Key: type: integer description: Specifies the default question type. format: int32 nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true numericAnswer: type: boolean description: 'Identifies that the question requires a numeric answer. Note: This field is marked as NOT NULL in the database and therefore required by the API.' question: maxLength: 512 type: string description: Displays the text of the question. nullable: true textAnswer: type: boolean description: 'Identifies that the question requires a text answer. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true yesNoAnswer: type: boolean description: 'Identifies that the question requires a yes or no answer. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false CredAttestationQuestionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredAttestationQuestion' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredAttestationQuestionVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredAttestationQuestion' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredAttestationSource: required: - credAttestationSource_Key type: object properties: credAttestationSource_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: A description area used to provide more detail about the attestation source. nullable: true display: maxLength: 128 type: string description: Identifies the name of the attestation source. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredAttestationSourceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredAttestationSource' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredAttestationSourceVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredAttestationSource' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredAttestationType: required: - credAttestationType_Key type: object properties: credAttestationType_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the attestation type. nullable: true display: maxLength: 128 type: string description: Display name of the attestation type. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredAttestationTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredAttestationType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredAttestationTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredAttestationType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredCarrier: required: - credCarrier_Key type: object properties: credCarrier_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 address: maxLength: 128 type: string description: Address of the credentialing Carrier. nullable: true address2: maxLength: 128 type: string description: Address line 2 of the credentialing Carrier. nullable: true city: maxLength: 32 type: string description: City of the address of the credentialing Carrier. nullable: true country_ID: maxLength: 8 type: string description: Country ID of the credentialing Carrier's address. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true fax: maxLength: 32 type: string description: Fax number of the credentialing Carrier. nullable: true fax_Country_Code: maxLength: 8 type: string description: Country code of the credentialing Carrier's fax number. nullable: true name: maxLength: 128 type: string description: Name of the credentialing Carrier. nullable: true phone: maxLength: 32 type: string description: Phone number of the credentialing Carrier. nullable: true phone_Country_Code: maxLength: 8 type: string description: Country code of the credentialing Carrier's phone number. nullable: true state: maxLength: 2 type: string description: State of the address of the credentialing Carrier. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true zip_Code: maxLength: 32 type: string description: Zip code of the credentialing Carrier. nullable: true additionalProperties: false CredCarrierListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredCarrier' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredCarrierVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredCarrier' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredCertification: required: - credCertification_Key type: object properties: credCertification_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the credentialing certification. nullable: true display: maxLength: 128 type: string description: Name of the credentialing certification. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredCertificationListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredCertification' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredCertificationVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredCertification' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredConfidential: required: - credConfidential_Key type: object properties: credConfidential_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the confidential. nullable: true display: maxLength: 128 type: string description: Name of the confidental. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredConfidentialListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredConfidential' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredConfidentialVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredConfidential' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredContract: required: - credContract_Key type: object properties: credContract_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the contract. nullable: true display: maxLength: 128 type: string description: Name of the contract. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredContractListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredContract' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredContractVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredContract' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredDate: required: - credDate_Key type: object properties: credDate_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the credentialing date. nullable: true display: maxLength: 128 type: string description: Name of the credentialing date. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredDateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredDate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredDateVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredDate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredEducationType: required: - credEducationType_Key type: object properties: credEducationType_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the education type. nullable: true display: maxLength: 128 type: string description: Name of the education type. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredEducationTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredEducationType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredEducationTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredEducationType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredLicenseType: required: - credLicenseType_Key type: object properties: credLicenseType_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the license type. nullable: true display: maxLength: 128 type: string description: Name of the license type. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredLicenseTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredLicenseType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredLicenseTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredLicenseType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredOption: required: - credOption_Key type: object properties: credOption_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the credentialing option. nullable: true display: maxLength: 128 type: string description: Name of the credentialing option. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredOptionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredOption' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredOptionVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredOption' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredPracticeCategory: required: - credPracticeCategory_Key type: object properties: credPracticeCategory_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the practice category. nullable: true display: maxLength: 128 type: string description: Name of the practice category. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredPracticeCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredPracticeCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredPracticeCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredPracticeCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredPracticeType: required: - credPracticeCategory_Key - credPracticeType_Key type: object properties: credPracticeType_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 credPracticeCategory_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the practice type. nullable: true display: maxLength: 128 type: string description: Name of the practice type. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredPracticeTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredPracticeType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredPracticeTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredPracticeType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredQuality: required: - credQuality_Key type: object properties: credQuality_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the credentialing quality. nullable: true display: maxLength: 128 type: string description: Name of the credentialing quality. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredQualityListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredQuality' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredQualityVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredQuality' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredService: required: - credService_Key type: object properties: credService_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the credentialing service. nullable: true display: maxLength: 128 type: string description: Name of the credentialing service. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredServiceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredService' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredServiceVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredService' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredStatus: required: - cred_Status type: object properties: cred_Status: maxLength: 16 minLength: 1 type: string description: Name of the credentialing status. description: maxLength: 128 type: string description: Description of the credentialing status. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredTechnique: required: - credTechnique_Key type: object properties: credTechnique_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the credentialing technique. nullable: true display: maxLength: 128 type: string description: Name of the credentialing technique. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredTechniqueListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredTechnique' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredTechniqueVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredTechnique' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredTermination: required: - credTermination_Key - voluntary type: object properties: credTermination_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the credentaling termination. nullable: true display: maxLength: 128 type: string description: Name of the credentialing termination. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true voluntary: type: boolean description: 'Indicates that this credentialing termination is a voluntary one. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false CredTerminationListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredTermination' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredTerminationVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredTermination' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredType: required: - credType_Key type: object properties: credType_Key: type: integer description: 'Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the credentialing type. nullable: true display: maxLength: 128 type: string description: Name of the credentialing type. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false CredTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/CredType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CredTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/CredType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Criteria: type: object properties: searchConfigId: maxLength: 32 type: string description: The SaerchConfig for which this Criteria will be applied. nullable: true criteria_Key: type: integer description: Key value identifying a specific criteria. Omit this field when creating a new record. format: int32 criteria_Type: maxLength: 32 type: string description: Identifies the type associated with the criteria. Use the name of the SearchConfig for which you want to apply this Criteria. nullable: true criteria_User: maxLength: 20 type: string description: Identifies the User associated with the criteria. nullable: true description: maxLength: 512 type: string description: Description of the criteria. nullable: true criteriaDetails: type: array items: $ref: '#/components/schemas/CriteriaDetail' description: List of details applied to the Criteria. nullable: true temporary: type: boolean description: 'If true, criteria is not included as a "saved search", if false, the criteria is persisted as a "saved search" in accordance to the comapny''s criteria persistance settings.' additionalProperties: false CriteriaDetail: required: - criteria_Seq type: object properties: criteria_Key: type: integer description: "Unique identifier of the Criteria for which this Criteria Details object belongs. \r\nWhen creating a new Critiera object, omit this from the payload." format: int32 criteria_Seq: type: integer description: "The sequential order that the criteria details will be applied. \r\nIf you have multiple criteria details to add, this is important as it dictates the order in which they are applied and constructed (eg, if you have parenthesis or concatenate with AND's / OR's)." format: int32 criteria_AndOr: maxLength: 3 type: string description: "Specifies the AND/OR when multiple conditions are specified for a criteria.\r\nIf making a complex query, use this to concatenate multiple criteria. For example, use the value \"Or\" if you want to match either this criteria or the next criteria. If not needed, use null or omit." nullable: true criteria_Column: maxLength: 64 type: string description: "Column containing the value for the criteria condition specified,\r\nThe column within the Criteria_Table for whcih this criteria will be applied." nullable: true criteria_Data_Type: maxLength: 32 type: string description: "Data type of the value for the criteria condition specified\r\nThe data type of the column value MUST be populated and MUST be one of the following values: string, date, or number" nullable: true criteria_From_Value: maxLength: 256 type: string description: "First value of a range or only value for a single value of the criteria condition specified\r\nThe value to use against the Criteria_Operator when comparing values (eg, >, >=, etc). If a Criteria_Operator requires two values (eg, for BETWEEN) then this is the beginning value. If not needed, use null or omit." nullable: true criteria_Left_Paren: maxLength: 16 type: string description: "Optional field used to hold a parenthesis for nesting criteria conditions\r\nAllows you to start a parenthetical expression. Add \"(\" to start the parenthesis grouping. If not needed, use null or omit. An example of a criteria using parenthesis would be (x=1 OR x=2) OR (y=1 OR y=2)." nullable: true criteria_Operator: maxLength: 32 type: string nullable: true criteria_Right_Paren: maxLength: 16 type: string description: "Optional field used to hold a parenthesis for nesting criteria conditions\r\nAllows you to end a parenthetical expression. Add \")\" to end the parenthesis grouping. If not needed, use null or omit. An example of a criteria using parenthesis would be (x=1 OR x=2) OR (y=1 OR y=2)." nullable: true criteria_Table: maxLength: 64 type: string description: "Table where a column for criteria condition is found\r\nThe table for which this criteria will be applied. The table should exist within the SearchConfig that this criteria is being applied." nullable: true criteria_Thru_Value: maxLength: 256 type: string description: "Optional ending value of a range for the criteria condition specified\r\nIf a Criteria_Operator requires two values (eg, for BETWEEN) then this is the ending value. If not needed, use null or omit." nullable: true additionalProperties: false CriteriaListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Criteria' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CriteriaVBAResponse: type: object properties: data: $ref: '#/components/schemas/Criteria' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Currency: required: - currency_ID type: object properties: currency_ID: maxLength: 16 minLength: 1 type: string description: Name for the currency. description: maxLength: 128 type: string description: Description of the currency. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false CurrencyListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Currency' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false CurrencyVBAResponse: type: object properties: data: $ref: '#/components/schemas/Currency' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DRGCluster: required: - drG_Cluster type: object properties: drG_Cluster: maxLength: 32 minLength: 1 type: string description: Identifier for the DRG cluster. description: maxLength: 256 type: string description: Description of the DRG cluster. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false DRGClusterDetail: required: - drG_Cluster - drgClusterDetail_Key type: object properties: drgClusterDetail_Key: type: integer description: Key value identifying the details for a DRG Cluster format: int32 drG_Cluster: maxLength: 32 minLength: 1 type: string description: Identifier for the DRG cluster. drG_Code_From: maxLength: 8 type: string description: First DRG Code in the range of codes associated with the DRG Cluster nullable: true drG_Code_Thru: maxLength: 8 type: string description: Last DRG Code in the range of codes associated with the DRG Cluster nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false DRGClusterDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DRGClusterDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DRGClusterDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/DRGClusterDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DRGClusterListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DRGCluster' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DRGClusterVBAResponse: type: object properties: data: $ref: '#/components/schemas/DRGCluster' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DRGCodes: required: - drG_Code type: object properties: drG_Code: maxLength: 8 minLength: 1 type: string description: Code identifying a specific DRG cervicalOrLumbar: maxLength: 1 type: string description: Flag that specifies if the DRG is related to cervical or lumbar nullable: true description: maxLength: 128 type: string description: Description of the DRG nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false DRGCodesVBAResponse: type: object properties: data: $ref: '#/components/schemas/DRGCodes' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DRGSchedule: required: - drG_Schedule type: object properties: drG_Schedule: maxLength: 16 minLength: 1 type: string description: Name for the DRG schedule. description: maxLength: 512 type: string description: Description of the DRG schedule. nullable: true additionalProperties: false DRGScheduleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DRGSchedule' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DRGScheduleVBAResponse: type: object properties: data: $ref: '#/components/schemas/DRGSchedule' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DRGWeight: required: - drG_Code - drG_Schedule - effective_Date type: object properties: drG_Schedule: maxLength: 16 minLength: 1 type: string description: Identifier for DRG Schedule drG_Code: maxLength: 8 minLength: 1 type: string description: Code identifying a specific DRG effective_Date: type: string description: Date the DRG Schedule becomes effective format: date-time term_Date: type: string description: Date the DRG Schedule terminates format: date-time nullable: true weight: type: number description: Weight that is applied to the specified DRG format: double nullable: true additionalProperties: false DRGWeightListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DRGWeight' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DRGWeightVBAResponse: type: object properties: data: $ref: '#/components/schemas/DRGWeight' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DatabaseConnection: type: object properties: databaseName: type: string nullable: true connectionString: type: string nullable: true additionalProperties: false DayInterval: required: - holiday - interval_Day - interval_Month - interval_Year type: object properties: interval_Year: type: integer description: Year of the date or interval used in internal date calculations format: int32 interval_Month: type: integer description: Month of the date or interval used in internal date calculations format: int32 interval_Day: type: integer description: Day of the date or interval used in internal date calculations format: int32 day_From_Date: type: string description: Date and time stamp of the beginning of the specified day format: date-time nullable: true day_Name: maxLength: 12 type: string description: Full name of the day of the week nullable: true day_Short_Name: maxLength: 3 type: string description: Abbreviated name of the day of the week nullable: true day_Thru_Date: type: string description: Date and time stamp of the end of the specified day format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true holiday: type: boolean description: Bit indicating if the specified day falls on recognized holiday month_From_Date: type: string description: First day of the month containing the date specified format: date-time nullable: true month_Thru_Date: type: string description: Last day of the month containing the date specified format: date-time nullable: true quarter: type: integer description: Number indicating the quarter containing the date specified format: int32 nullable: true quarter_From_Date: type: string description: First day of the quarter containing the date specified format: date-time nullable: true quarter_Thru_Date: type: string description: Last day of the quarter containing the date specified format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true week_Day: type: integer description: Number of the day of the week where Sunday is 1 format: int32 nullable: true weekend: type: boolean description: Bit indicating if the specified day falls on the weekend nullable: true yearMonthDay_Seq: type: integer description: Sequence number used for simple date comparisons format: int32 nullable: true additionalProperties: false DayIntervalListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DayInterval' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DayIntervalVBAResponse: type: object properties: data: $ref: '#/components/schemas/DayInterval' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Debug: required: - activityID type: object properties: activityID: minLength: 1 type: string additionalProperties: false DiagnosticCode: required: - accident - age_Restricted - diagnostic_Code - diagnostic_Code_Type - effective_Date - pre_Ex - sec111 - trigger_Diagnosis - valid type: object properties: diagnostic_Code: maxLength: 8 minLength: 1 type: string diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string effective_Date: type: string format: date-time accident: type: boolean age_Range_Type: maxLength: 1 type: string nullable: true age_Restricted: type: boolean age_Type: maxLength: 16 type: string nullable: true drG_Code: maxLength: 8 type: string nullable: true diag_Description: maxLength: 128 type: string nullable: true diag_IVR: maxLength: 8 type: string nullable: true diagnostic_Group: maxLength: 32 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true financial_Type: maxLength: 32 type: string nullable: true from_Age: type: integer format: int32 nullable: true gender: maxLength: 1 type: string nullable: true long_Description: maxLength: 512 type: string nullable: true pend_Ex_Code: maxLength: 6 type: string nullable: true pend_Flag: maxLength: 1 type: string nullable: true pre_Ex: type: boolean sec111: type: boolean term_Date: type: string format: date-time nullable: true thru_Age: type: integer format: int32 nullable: true trigger_Diagnosis: type: boolean update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true valid: type: boolean additionalProperties: false DiagnosticCodeGroup: required: - diagnostic_Group type: object properties: diagnostic_Group: maxLength: 32 minLength: 1 type: string description: Name for the diagnostic group. description: maxLength: 512 type: string description: Description of the diagnostic group. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false DiagnosticCodeGroupListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DiagnosticCodeGroup' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DiagnosticCodeGroupVBAResponse: type: object properties: data: $ref: '#/components/schemas/DiagnosticCodeGroup' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DiagnosticCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DiagnosticCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DiagnosticCodeType: required: - diagnostic_Code_Type type: object properties: diagnostic_Code_Type: maxLength: 8 minLength: 1 type: string description: Name for the diagnostic code type. description: maxLength: 64 type: string description: Description of the diagnostic code type. nullable: true additionalProperties: false DiagnosticCodeTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DiagnosticCodeType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DiagnosticCodeTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/DiagnosticCodeType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DiagnosticCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/DiagnosticCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisabilityEventCaseChanged: required: - disabilityEventCaseChanged_Key type: object properties: disabilityEventCaseChanged_Key: type: integer description: 'ID for the disability event case change. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 case_Status: maxLength: 8 type: string description: Identifies the status of the case associated with the diability event change. 'Disability Case Statuses' are configured within 'Disability Claim Configuration'. nullable: true case_Status_Reason: maxLength: 8 type: string description: Identifies the reason of the case associated with the disability event change. 'Disability Case Reasons' are configured within 'Disability Claim Configuration'. nullable: true disability_Type: maxLength: 8 type: string description: Identifies the type of disability (injury or illness) associated with the event change. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true ex_Code: maxLength: 6 type: string description: Indicates the Ex Code that will be applied to the claim receiving the disability event case change. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false DisabilityEventCaseChangedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DisabilityEventCaseChanged' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisabilityEventCaseChangedVBAResponse: type: object properties: data: $ref: '#/components/schemas/DisabilityEventCaseChanged' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisabilityEventDeductionChanged: required: - disabilityEventDeductionChanged_Key type: object properties: disabilityEventDeductionChanged_Key: type: integer description: 'Unique Identifier for the DisabilityEventDeductionChanged table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 deduction_Type: maxLength: 8 type: string description: Identifies the type of deduction associated with the disability event change. 'Deduction Types' are configured within 'Disability Claim Configuration'. nullable: true disability_Type: maxLength: 8 type: string description: Identifies the type of disability (injury or illness) associated with the deduction change. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true ex_Code: maxLength: 6 type: string description: Indicates the Ex Code that will be applied to the claim receiving the disability event deduction change. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false DisabilityEventDeductionChangedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DisabilityEventDeductionChanged' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisabilityEventDeductionChangedVBAResponse: type: object properties: data: $ref: '#/components/schemas/DisabilityEventDeductionChanged' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisabilityEventField: required: - field_Name type: object properties: field_Name: maxLength: 128 minLength: 1 type: string description: Name of the Field for the Event. entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true field_Display: maxLength: 256 type: string description: Display name of the Field for the Event. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false DisabilityEventFieldChanged: required: - disabilityEventFieldChanged_Key type: object properties: disabilityEventFieldChanged_Key: type: integer description: 'Unique Identifier for the DisabilityEventFieldChanged table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 disability_Type: maxLength: 8 type: string description: Identifies the type of disability (injury or illness). nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true ex_Code: maxLength: 6 type: string description: Explanation Code for this Change. nullable: true field_Name: maxLength: 128 type: string description: Name of the Field that was Changed. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false DisabilityEventFieldChangedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DisabilityEventFieldChanged' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisabilityEventFieldChangedVBAResponse: type: object properties: data: $ref: '#/components/schemas/DisabilityEventFieldChanged' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisabilityEventFieldListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DisabilityEventField' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisabilityEventFieldVBAResponse: type: object properties: data: $ref: '#/components/schemas/DisabilityEventField' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisabilityEventGroup: required: - disabilityEventGroup_Key type: object properties: disabilityEventGroup_Key: type: integer description: 'Unique Identifier for the DisabilityEventGroup table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 disabilityEventCaseChanged_Key: type: integer description: Unique Identifier for the DisabilityEventCaseChanged table. format: int32 nullable: true disabilityEventChanged_Key: type: integer description: Unique Identifier for the DisabilityEventChanged table. format: int32 nullable: true disabilityEventDeductionChanged_Key: type: integer description: Unique Identifier for the DisabilityEventDeductionChanged table. format: int32 nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true group_ID: maxLength: 20 type: string description: Group ID for the DisabilityEventGroup nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false DisabilityEventGroupListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DisabilityEventGroup' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisabilityEventGroupVBAResponse: type: object properties: data: $ref: '#/components/schemas/DisabilityEventGroup' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisabilityPlanLimit: required: - disabilityPlanLimit_Key type: object properties: disabilityPlanLimit_Key: type: integer description: Unique Identifier for the DisabilityPlanLimit table. format: int32 age_From: type: integer description: Starting Age the plan limit applies to. format: int32 nullable: true age_Thru: type: integer description: Ending Age the plan limit applies to. format: int32 nullable: true age_Type: maxLength: 8 type: string description: Age Type the plan limit applies to. nullable: true disability_Type: maxLength: 8 type: string description: Identifies the type of disability (injury or illness). nullable: true limit: type: integer description: Plan limit to apply. format: int32 nullable: true limit_Type: maxLength: 1 type: string description: Type of plan limit. nullable: true limit_Type_From: maxLength: 8 type: string description: Starting value the plan limit applies to. nullable: true plan_ID: maxLength: 20 type: string description: Plan ID of the plan to limit. nullable: true additionalProperties: false DisabilityPlanLimitListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DisabilityPlanLimit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisabilityPlanLimitVBAResponse: type: object properties: data: $ref: '#/components/schemas/DisabilityPlanLimit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisableMFASetupRequest: required: - user_ID type: object properties: user_ID: minLength: 1 type: string description: The unique identifier of the user whose MFA settings are to be disabled. additionalProperties: false Disaster: required: - disaster_Key type: object properties: disaster_Key: type: integer description: 'Unique identifer for each disaster entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 256 type: string description: The description of the Disaster. nullable: true disaster_ID: maxLength: 20 type: string description: User defined identifier for the Disaster nullable: true effective_Date: type: string description: Date when the disaster becomes/became effective. format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true ex_Code: maxLength: 6 type: string description: The ExCode applied to this disaster entry. nullable: true term_Date: type: string description: Date when the disaster no longe applies. format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false DisasterListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Disaster' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisasterLocation: required: - disasterLocation_Key type: object properties: disasterLocation_Key: type: integer description: 'Unique identifer for each disaster location entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 county_Code: maxLength: 8 type: string description: County Code associated with the disaster. nullable: true disaster_Key: type: integer description: 'Unique identifer for each disaster entry, references Disaster.Disaster_Key .' format: int32 nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true state: maxLength: 2 type: string description: State associated with the disaster. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true zip_Code: maxLength: 32 type: string description: US Zip Code associated with the disaster. nullable: true additionalProperties: false DisasterLocationListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DisasterLocation' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisasterLocationVBAResponse: type: object properties: data: $ref: '#/components/schemas/DisasterLocation' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DisasterVBAResponse: type: object properties: data: $ref: '#/components/schemas/Disaster' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DrugCode: required: - drug_Code - drugCode_Key type: object properties: drugCode_Key: type: integer format: int32 application_Number: maxLength: 32 type: string nullable: true deA_Schedule: maxLength: 64 type: string nullable: true description: type: string nullable: true dosage_For_Name: maxLength: 512 type: string nullable: true drug_Code: maxLength: 32 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true labeler_Code: maxLength: 6 type: string nullable: true labeler_Name: maxLength: 512 type: string nullable: true listing_Record_Certified_Through: type: string format: date-time nullable: true marketing_Category_Name: maxLength: 64 type: string nullable: true ndC_Package_Code: maxLength: 32 type: string nullable: true non_Proprietary_Name: maxLength: 512 type: string nullable: true package_Code: maxLength: 2 type: string nullable: true package_End_Marketing_Date: type: string format: date-time nullable: true package_NDC_Exclude_Flag: maxLength: 8 type: string nullable: true package_Size: maxLength: 25 type: string nullable: true package_Start_Marketing_Date: type: string format: date-time nullable: true package_Type: maxLength: 25 type: string nullable: true pharmacy_Class: type: string nullable: true product_Code: maxLength: 32 type: string nullable: true product_End_Marketing_Date: type: string format: date-time nullable: true product_NDC_Exclude_Flag: maxLength: 8 type: string nullable: true product_Start_Marketing_Date: type: string format: date-time nullable: true product_Type_Name: maxLength: 512 type: string nullable: true proprietary_Name: maxLength: 512 type: string nullable: true proprietary_Name_Suffix: maxLength: 64 type: string nullable: true rX_OTC: maxLength: 1 type: string nullable: true route_Name: maxLength: 512 type: string nullable: true sample_Package: maxLength: 8 type: string nullable: true strength: maxLength: 32 type: string nullable: true substance_Name: maxLength: 512 type: string nullable: true trade_Name: maxLength: 100 type: string nullable: true unit: maxLength: 32 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false DrugCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DrugCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DrugCodeUnit: required: - drugCode_Unit type: object properties: drugCode_Unit: maxLength: 32 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true unit_Description: maxLength: 256 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false DrugCodeUnitListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DrugCodeUnit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DrugCodeUnitVBAResponse: type: object properties: data: $ref: '#/components/schemas/DrugCodeUnit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DrugCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/DrugCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DuplicateColumn: required: - column_Name - duplicateColumn_Key - table_Name type: object properties: duplicateColumn_Key: type: integer format: int32 column_Name: maxLength: 50 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true table_Name: maxLength: 50 minLength: 1 type: string update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false DuplicateColumnListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DuplicateColumn' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DuplicateColumnVBAResponse: type: object properties: data: $ref: '#/components/schemas/DuplicateColumn' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DuplicateMaster: required: - duplicateMaster_Key type: object properties: duplicateMaster_Key: type: integer format: int32 description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false DuplicateMasterListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DuplicateMaster' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DuplicateMasterSet: required: - duplicateMaster_Key - duplicateSet_Key type: object properties: duplicateMaster_Key: type: integer format: int32 duplicateSet_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false DuplicateMasterSetListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DuplicateMasterSet' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DuplicateMasterSetVBAResponse: type: object properties: data: $ref: '#/components/schemas/DuplicateMasterSet' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DuplicateMasterVBAResponse: type: object properties: data: $ref: '#/components/schemas/DuplicateMaster' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DuplicateSet: required: - check_Claim - claim_Type - duplicateSet_Key - no_Dupe_On_Denied - soft_Dupe_On_Denied type: object properties: duplicateSet_Key: type: integer format: int32 check_Claim: type: boolean claim_Type: maxLength: 20 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true hard_Duplicate_Ex_Code: maxLength: 6 type: string nullable: true no_Dupe_On_Denied: type: boolean soft_Dupe_On_Denied: type: boolean soft_Duplicate_Ex_Code: maxLength: 6 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false DuplicateSetColumn: required: - duplicateColumn_Key - duplicateSet_Key - hard_Duplicate - soft_Duplicate type: object properties: duplicateSet_Key: type: integer format: int32 duplicateColumn_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true hard_Duplicate: type: boolean soft_Duplicate: type: boolean update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false DuplicateSetColumnListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DuplicateSetColumn' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DuplicateSetColumnVBAResponse: type: object properties: data: $ref: '#/components/schemas/DuplicateSetColumn' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DuplicateSetListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DuplicateSet' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false DuplicateSetVBAResponse: type: object properties: data: $ref: '#/components/schemas/DuplicateSet' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EDICodeMap: required: - destination_Value - direction - ediCodeMap_Key - map_Type - source_Value type: object properties: ediCodeMap_Key: type: integer description: 'Key value that identifies the EDI code map Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 destination_Value: maxLength: 64 minLength: 1 type: string description: Value that is assigned at the destination when the source value is encountered direction: maxLength: 3 minLength: 1 type: string description: Specifies the direction of the EDI transfer - import or export effective_Date: type: string description: Optional date when the EDI code map condition becomes effective format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true map_Type: maxLength: 16 minLength: 1 type: string description: Type of map that is being used for the EDI transfer map_Variable1: maxLength: 128 type: string description: Variable associated with the EDI code map nullable: true map_Variable2: maxLength: 128 type: string description: Variable associated with the EDI code map nullable: true map_Variable3: maxLength: 128 type: string description: Variable associated with the EDI code map nullable: true map_Variable4: maxLength: 128 type: string description: Variable associated with the EDI code map nullable: true map_Variable5: maxLength: 128 type: string description: Variable associated with the EDI code map nullable: true source_Value: maxLength: 64 minLength: 1 type: string description: Value specified by the source that needs to be mapped term_Date: type: string description: Optional date when the EDI code map condition terminates format: date-time nullable: true trading_Partner_Key: type: integer description: Kev value that identifies the EDI trading partner or vendor format: int32 nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false EDICodeMapListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/EDICodeMap' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EDICodeMapVBAResponse: type: object properties: data: $ref: '#/components/schemas/EDICodeMap' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EDICustomField: required: - ediCustomField_Key - source type: object properties: ediCustomField_Key: type: integer description: 'Key value that identifies a custom field on and EDI load Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 field_Name: maxLength: 64 type: string description: Name of the EDI custom field nullable: true source: maxLength: 16 minLength: 1 type: string description: Source where the EDI custom field will retrieved from additionalProperties: false EDICustomFieldListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/EDICustomField' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EDICustomFieldVBAResponse: type: object properties: data: $ref: '#/components/schemas/EDICustomField' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EDICustomFieldValueClaim: required: - adjustment_Seq - batch_Claim - batch_Number - claim_Seq - ediCustomField_Key - ediCustomFieldValueClaim_Key type: object properties: ediCustomFieldValueClaim_Key: type: integer description: 'Key value that identifies a custom field value from a claim Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 adjustment_Seq: maxLength: 3 minLength: 1 type: string description: Adjustment sequence of the claim where the custom field will be stored batch_Claim: type: integer description: 'Batch claim number of the claim where the custom field will be stored Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 batch_Number: type: integer description: 'Batch number of the claim where the custom field will be stored Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 claim_Seq: maxLength: 2 minLength: 1 type: string description: Batch claim sequence of the claim where the custom field will be stored ediCustomField_Key: type: integer description: 'Key value that identifies a custom field on and EDI load Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 field_DataType: maxLength: 32 type: string description: Data type of the custom field on the EDI claim load nullable: true field_Value: type: string description: Data value of the custom field on the EDI claim load nullable: true additionalProperties: false EDICustomFieldValueClaimListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/EDICustomFieldValueClaim' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EDICustomFieldValueClaimVBAResponse: type: object properties: data: $ref: '#/components/schemas/EDICustomFieldValueClaim' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ElectronicStatement: type: object properties: transaction_ID: type: string nullable: true transaction_Type: type: string nullable: true transaction_Date: type: string format: date-time nullable: true transaction_Amount: type: number format: double nullable: true additionalProperties: false EligibilityStatus: required: - eligibility_Status - sec111_Exclude - sec111_Include type: object properties: eligibility_Status: maxLength: 8 minLength: 1 type: string description: Identifier for a specified eligibility status description: maxLength: 64 type: string description: Description of the eligibility status nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true sec111_Exclude: type: boolean description: 'Indicates if the eligibility status excludes section 111 Note: This field is marked as NOT NULL in the database and therefore required by the API.' sec111_Include: type: boolean description: 'Indicates if the eligibility status includes section 111 Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false EligibilityStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/EligibilityStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EligibilityStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/EligibilityStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EmailReportDTO: type: object properties: parentActivityId: type: string description: Activity ID that spawned this nullable: true when: type: string format: date-time nullable: true onSuccess: $ref: '#/components/schemas/CallbackDTO' onFailure: $ref: '#/components/schemas/CallbackDTO' reportId: type: string description: ID of the Report nullable: true exportType: type: string description: 'Export Type. Valid values are: Excel, Html, Pdf, Word, PPT, CSV' nullable: true siteId: type: string description: "Client specific Site ID within the report server. \r\nThis is typically their Client ID, but may be different based on client needs." nullable: true filename: type: string description: Filename of the report. nullable: true reportParameters: type: object additionalProperties: type: string nullable: true description: "An object of report parameters\r\nRequired if a report requires them." nullable: true from: type: string description: The sender of the email containing the report. This should be a valid email address. nullable: true recipients: type: array items: type: string description: All recipients of the email containing the report. Each entry should be a valid email address. nullable: true subject: type: string description: Subject of the email for the report. nullable: true body: type: string description: Body content of the email for the report. nullable: true additionalProperties: false EnableMFASetupRequest: required: - user_ID type: object properties: user_ID: minLength: 1 type: string description: The unique identifier of the user whose MFA settings are to be enabled. additionalProperties: false EnrollmentDisenroll: required: - disenroll_Date - disenrollFamily - disenrollFuture - division_ID - group_Coverage_Start - group_ID - member_Seq - reason_ID - start_Date - subscriber - subscriber_ID - terminateAuth - user_ID type: object properties: user_ID: maxLength: 20 minLength: 1 type: string description: The user for which this request is executed on behalf of. subscriber_ID: maxLength: 9 minLength: 1 type: string description: The Subscirber ID of the Member being disenrolled. You can get the Subscriber ID via the SearchConfig process using ENROLLMENT searchConfigId (https://vbapi-docs.vbasoftware.com/developer-portal/search/). member_Seq: maxLength: 2 minLength: 1 type: string description: 'The Member Sequence of the Member being disenrolled. If this is a Subscriber Disenroll, the Member Sequence provided is the Insured Member Sequence. You can get the Member Seq via the SearchConfig process using ENROLLMENT searchConfigId (https://vbapi-docs.vbasoftware.com/developer-portal/search/).' group_ID: maxLength: 20 minLength: 1 type: string description: 'The Group ID of the current Subenrollment record (the members current or most recent enrollment). You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need.' division_ID: maxLength: 20 minLength: 1 type: string description: 'The Division ID of the current Subenrollment record (the members current or most recent enrollment). You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need.' group_Coverage_Start: type: string description: 'The Group Coverage Start of the current Subenrollment record (the members current or most recent enrollment). You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need. This is only required on Subscriber/Member Disenrolls, for Group/Division Disenroll, this can be blank.' format: date-time start_Date: type: string description: 'The Start Date of the current Subenrollment record (the members current or most recent enrollment). You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need. This is only required on Subscriber/Member Disenrolls, for Group/Division Disenroll, this can be blank.' format: date-time disenroll_Date: type: string description: The Disenroll Date for this disenroll process. format: date-time term_Date: type: string description: Term Date is an informational field used in some reports. It doesn't impact the process but is often populated with the same value as the Disenroll Date. format: date-time nullable: true subscriber: type: boolean description: 'The Subscriber value is a flag indicating if the member being disenrolled is the Insured. Send 1 if this is the Subscriber, send 0 if this is a Spouse/Dependent/Other. This is only required on Subscriber/Member Disenrolls, for Group/Division Disenroll, this can be blank.' reason_ID: type: integer description: Reason ID is the reson for this disenroll. You can get a list of valid Reason IDs from the List Reasons API (https://vbapi.vbasoftware.com/vbasoftware/reasons). format: int32 premium: type: number description: 'When not using the PremRates list of PremRate_Key values, this indicates the COBRA Premium for some reports.' format: double nullable: true disenrollFamily: type: integer description: The DisenrollFamily indicator lets the Disenroll process know exactly how to perform the Disenroll. You can get a list of valid DisenrollFamily values from the List Disenrollment Family Options API (https://vbapi.vbasoftware.com/vbasoftware/disenroll-family-options). format: int32 terminateAuth: type: boolean description: The TerminateAuth flag lets us know if Auths approved or requested beyond the Disenroll Date should be cancelled. disenrollFuture: type: integer description: "The DisenrollFuture indicator will tell us how to handle any future enrollments beyond the Disenroll Date related to this disenroll. The valid values are:\r\n2 - Disenroll Future Enrollments\r\n3 - Do Not Disenroll any Future Enrollments" format: int32 premRates: type: array items: type: integer format: int32 description: The list of COBRA Rates associated with this Disenroll process. nullable: true premInvoiceAdjustments: type: array items: $ref: '#/components/schemas/PremInvoiceAdjustment' description: If you intend to auto-adjust existing premiums based on this disenroll you would populate your adjustments here. nullable: true additionalProperties: false EnrollmentDisenrollGroup: required: - disenroll_Date - disenrollFamily - disenrollFuture - group_ID - groupDisenroll - reason_ID - terminateAuth - user_ID type: object properties: user_ID: maxLength: 20 minLength: 1 type: string description: The user for which this request is executed on behalf of. group_ID: maxLength: 20 minLength: 1 type: string description: The Group ID you would like to perform the disenroll. You can use the List Groups API (https://vbapi.vbasoftware.com/vbasoftware/groups) to get the values you need. division_ID: maxLength: 20 type: string description: 'The Division ID to be disenrolled if you intend to disenroll only a specific Division. Leave this blank if you intend to disenroll all Divisions in a group. You can use the List GroupDivisions API (https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions) to get the values you need.' nullable: true disenroll_Date: type: string description: The Disenroll Date for this disenroll process. format: date-time term_Date: type: string description: Term Date is an informational field used in some reports. It doesn't impact the process but is often populated with the same value as the Disenroll Date. format: date-time nullable: true reason_ID: type: integer description: Reason ID is the reson for this disenroll. You can get a list of valid Reason IDs from the List Reasons API (https://vbapi.vbasoftware.com/vbasoftware/reasons). format: int32 disenrollFamily: type: integer description: The DisenrollFamily indicator lets the Disenroll process know exactly how to perform the Disenroll. You can get a list of valid DisenrollFamily values from the List Disenrollment Family Options API (https://vbapi.vbasoftware.com/vbasoftware/disenroll-family-options). format: int32 terminateAuth: type: boolean description: The TerminateAuth flag lets us know if Auths approved or requested beyond the Disenroll Date should be cancelled. disenrollFuture: type: integer description: "The DisenrollFuture indicator will tell us how to handle any future enrollments beyond the Disenroll Date related to this disenroll. The valid values are:\r\n2 - Disenroll Future Enrollments\r\n3 - Do Not Disenroll any Future Enrollments" format: int32 groupDisenroll: type: boolean description: 'The flag is required and is set based on the disenroll you are performing. Set this value to true if you intend to Disenroll the Group. If you send in Divisioni_ID to disenroll a specific Division, this flag will then disenroll the group and the division sent but not other divisions.' additionalProperties: false EnrollmentPCPAutoAssign: required: - groupCriterias - networkCriterias - options type: object properties: options: $ref: '#/components/schemas/OptionCriteria' groupCriterias: type: array items: $ref: '#/components/schemas/GroupCriteria' networkCriterias: type: array items: $ref: '#/components/schemas/NetworkCriteria' specialtyCriterias: type: array items: $ref: '#/components/schemas/SpecialtyCriteria' nullable: true practiceTypeCriterias: type: array items: $ref: '#/components/schemas/PracticeTypeCriteria' nullable: true idCodeCriterias: type: array items: $ref: '#/components/schemas/IDCodeCriteria' nullable: true additionalProperties: false EnrollmentPCPAutoAssign_Member: type: object properties: subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true birth_Date: type: string format: date-time nullable: true zip_Code: type: string nullable: true group_ID: type: string nullable: true division_ID: type: string nullable: true group_Coverage_Start: type: string format: date-time nullable: true date_Enrolled: type: string format: date-time nullable: true age: type: integer format: int32 nullable: true sex: type: string nullable: true first_Name: type: string nullable: true last_Name: type: string nullable: true additionalProperties: false EnrollmentPCPAutoAssign_MemberListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/EnrollmentPCPAutoAssign_Member' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EnrollmentPCPAutoAssign_Provider: type: object properties: provider_ID: type: string nullable: true zip_Code: type: string nullable: true practice_Type: type: string nullable: true network_ID: type: string nullable: true accepting_Patients: type: boolean specialty_Code: type: string nullable: true effective_Date: type: string format: date-time nullable: true expiration_Date: type: string format: date-time nullable: true accepting_Age_From: type: integer format: int32 nullable: true accepting_Age_Thru: type: integer format: int32 nullable: true member_Provider_Count: type: integer format: int32 nullable: true additionalProperties: false EnrollmentPCPAutoAssign_ProviderListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/EnrollmentPCPAutoAssign_Provider' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EnrollmentPolicyForfeiture: type: object properties: plan_ID: type: string nullable: true benefit_Code: type: string nullable: true subscriber_ID: type: string nullable: true policy_Number: type: string nullable: true cash_Value: type: number format: double nullable: true rpu: type: number format: double nullable: true current_Policy_Status: type: string nullable: true current_Forfeiture_Status: type: string nullable: true current_Status_End: type: string format: date-time nullable: true suggested_Policy_Status: type: string nullable: true suggested_Policy_Status_Date: type: string format: date-time nullable: true maturity_Date: type: string format: date-time nullable: true policy_Duration: type: integer format: int32 nullable: true subscriber_Age: type: integer format: int32 nullable: true invoice_Key: type: integer format: int32 nullable: true additionalProperties: false EnrollmentReenroll: required: - user_ID type: object properties: user_ID: maxLength: 20 minLength: 1 type: string description: The user for which this request is executed on behalf of. subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true group_ID: type: string nullable: true division_ID: type: string nullable: true reenrollFamily: type: integer format: int32 nullable: true subscriber: type: boolean start_Date: type: string format: date-time nullable: true reenrollCOBRA: type: boolean resetAuth: type: boolean disenroll_Date: type: string format: date-time nullable: true cobraDivision: type: string nullable: true cobraCovStart: type: string format: date-time nullable: true cobraStart: type: string format: date-time nullable: true cobraEnd: type: string format: date-time nullable: true cobraReason: type: integer format: int32 nullable: true generateInvoice: type: boolean invoiceDate: type: string format: date-time nullable: true groupReenroll: type: boolean resetGroupDisenroll: type: boolean reenrollAll: type: boolean cobraPlanCriterias: type: array items: $ref: '#/components/schemas/COBRAPlanCriteria' nullable: true memberSeqCriterias: type: array items: type: string nullable: true additionalProperties: false EnrollmentWaitingPeriod: required: - enrollmentWaitingPeriod_Key - include_Hire_Date type: object properties: enrollmentWaitingPeriod_Key: type: integer format: int32 division_ID: maxLength: 20 type: string nullable: true effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true group_ID: maxLength: 20 type: string nullable: true include_Hire_Date: type: boolean plan_ID: maxLength: 20 type: string nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true waiting_Period: type: integer format: int32 nullable: true waiting_Period_Type: maxLength: 32 type: string nullable: true additionalProperties: false EnrollmentWaitingPeriodByHireDate: type: object properties: priority: type: integer format: int32 nullable: true waiting_Period_Type: type: string nullable: true waiting_Period: type: integer format: int32 nullable: true date_Enrolled: type: string format: date-time nullable: true additionalProperties: false EnrollmentWaitingPeriodByHireDateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/EnrollmentWaitingPeriodByHireDate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EnrollmentWaitingPeriodListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/EnrollmentWaitingPeriod' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EnrollmentWaitingPeriodSubscriber: required: - division_ID - enrollmentWaitingPeriodSubscriber_Key - group_ID - subscriber_ID type: object properties: enrollmentWaitingPeriodSubscriber_Key: type: integer format: int32 date_Employed: type: string format: date-time nullable: true division_ID: maxLength: 20 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true group_ID: maxLength: 20 minLength: 1 type: string subscriber_ID: maxLength: 9 minLength: 1 type: string update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false EnrollmentWaitingPeriodSubscriberListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriber' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EnrollmentWaitingPeriodSubscriberVBAResponse: type: object properties: data: $ref: '#/components/schemas/EnrollmentWaitingPeriodSubscriber' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EnrollmentWaitingPeriodVBAResponse: type: object properties: data: $ref: '#/components/schemas/EnrollmentWaitingPeriod' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ErrorCategory: required: - error_Category type: object properties: error_Category: maxLength: 8 minLength: 1 type: string description: Identifier of the error category. description: maxLength: 64 type: string description: Description of the error category. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ErrorCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ErrorCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ErrorCategoryType: required: - error_Category - error_Code - error_Severity - error_Type type: object properties: error_Category: maxLength: 8 minLength: 1 type: string description: Identifier of the error category. error_Type: maxLength: 32 minLength: 1 type: string description: Type of errors specified in this category error_Code: maxLength: 8 minLength: 1 type: string description: Code of the specific error that is contained in the category description: maxLength: 64 type: string description: Description of the specific error nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true error_Severity: type: integer description: 'Severity of the specific error Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ErrorCategoryTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ErrorCategoryType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ErrorCategoryTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ErrorCategoryType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ErrorCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/ErrorCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ErrorSeverity: required: - error_Severity type: object properties: error_Severity: type: integer description: 'Name for the error severity. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 description: maxLength: 64 type: string description: Description of the error severity. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ErrorSeverityListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ErrorSeverity' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ErrorSeverityVBAResponse: type: object properties: data: $ref: '#/components/schemas/ErrorSeverity' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ErrorType: required: - error_Type type: object properties: error_Type: maxLength: 32 minLength: 1 type: string description: Name for the error type. description: maxLength: 64 type: string description: Description of the error type. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ErrorTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ErrorType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ErrorTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ErrorType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EthnicityCode: required: - ethnicity_Code type: object properties: ethnicity_Code: maxLength: 1 minLength: 1 type: string description: Name for the ethnicity code. description: maxLength: 32 type: string description: Description of the ethnicity code. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false EthnicityCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/EthnicityCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EthnicityCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/EthnicityCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Event: required: - claim_Audit_Event - event_ID - process_Automation_Event - reminder type: object properties: event_ID: type: integer description: 'ID of the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 claim_Audit_Event: type: boolean description: 'Flag to indicate if the event triggers a Claim Audit. Note: This field is marked as NOT NULL in the database and therefore required by the API.' completion_Date: type: string description: Date the Event was Completed. format: date-time nullable: true completion_Percent: type: number description: Current Percentage that the Event has Completed format: double nullable: true due_Date: type: string description: Due Date of the Event format: date-time nullable: true end_Date: type: string description: End Date of the Event format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true event_Processor: maxLength: 64 type: string description: Object used when processing the event nullable: true event_Type: maxLength: 32 type: string description: Identifier for the type of event nullable: true meta_Data: maxLength: 512 type: string description: Meta data pertaining to the overall event nullable: true next_Scheduled_Date: type: string description: Date when the 'Assigned User' will receive the next event reminder. format: date-time nullable: true next_Scheduled_Time: type: string description: Date when the event is due. format: date-time nullable: true priority: maxLength: 32 type: string description: Indicates the level of priority being assigned to the event. nullable: true process_Automation_Event: type: boolean description: 'Flag to indicate if the event triggers a Report Series. Note: This field is marked as NOT NULL in the database and therefore required by the API.' reminder: type: boolean description: 'Indicates that the ''Assigned User'' should receive a reminder regarding the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.' reminder_Event_ID: type: integer description: Event ID of the Reminder format: int32 nullable: true reportSeries_Key: type: integer description: The key of the Report Series this Event trigger. format: int32 nullable: true start_Date: type: string description: Start Date of the Event format: date-time nullable: true status: maxLength: 32 type: string description: Identifies the current status of the event. nullable: true subject: maxLength: 256 type: string description: Description of the event subject. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true userGroup_Key: type: integer description: Key value identifying the User Group to whom the event is assigned format: int32 nullable: true user_ID: maxLength: 16 type: string description: ID of the User to whom the event is assigned. nullable: true additionalProperties: false EventArg: required: - argument_Name - event_ID type: object properties: event_ID: type: integer description: 'ID of the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 argument_Name: maxLength: 256 minLength: 1 type: string description: Allows the User to choose from a list of existing process automation arguments to associate with the event. argument_Type: maxLength: 32 type: string description: Identifies the type of process automation argument. nullable: true argument_Value: maxLength: 512 type: string description: The value of the process automation argument. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false EventArgListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/EventArg' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EventArgVBAResponse: type: object properties: data: $ref: '#/components/schemas/EventArg' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EventListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Event' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EventSchedule: required: - event_ID - friday - monday - play_Sound - regenerate_Event - saturday - schedule_ID - sunday - thursday - tuesday - wednesday type: object properties: schedule_ID: type: integer description: 'ID of the event schedule. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 10 type: string description: Description of the event schedule. nullable: true end_Date: type: string description: Indicates the date when the event will stop occurring. format: date-time nullable: true end_Option: type: integer description: Indicates how the event will end. format: int32 nullable: true end_Time: type: string description: Indicates at what time the event will cease to occur on the defined date(s). format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true event_ID: type: integer description: 'ID of the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 frequency: type: integer description: Month the event occurs. format: int32 nullable: true frequency_Factor: type: integer description: Day the event occurs. format: int32 nullable: true friday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' interval_Option: type: integer description: 'Interval Options are Days, Weekdays, Day in Month, Relative Day in Month, Date, or date in Month.' format: int32 nullable: true monday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' next_Scheduled_Date: type: string description: Date when the next event occurrence will take place. format: date-time nullable: true next_Scheduled_Time: type: string description: Time when the next event occurrence will take place. format: date-time nullable: true play_Sound: type: boolean description: 'Flag identifying a sound is associated with the event Note: This field is marked as NOT NULL in the database and therefore required by the API.' regenerate_Event: type: boolean description: 'Flag specifying the event should be regenerated upon completion Note: This field is marked as NOT NULL in the database and therefore required by the API.' regeneration_Date_Part: maxLength: 10 type: string description: Date part used to qualify the length of interval when the event will regenerate nullable: true regeneration_Interval: type: integer description: Length of interval when the event will regenerate format: int32 nullable: true relative_Frequency: type: integer description: Day of the week the event occurs. format: int32 nullable: true saturday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' schedule_Interval: type: integer description: Indicates how often the event will occur. The interval will determine which options are available for the event schedule. format: int32 nullable: true sound_File: maxLength: 256 type: string description: Sound file to be played in association with the event nullable: true start_Date: type: string description: Indicates the date when the event will begin occurring by the defined recurrence options. format: date-time nullable: true start_Time: type: string description: Indicates at what time the event will occur on the defined date(s). format: date-time nullable: true sunday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' thursday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' total_Occurrences: type: integer description: Number of occurrences that will take place before the event ends. format: int32 nullable: true tuesday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true wednesday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false EventScheduleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/EventSchedule' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EventScheduleVBAResponse: type: object properties: data: $ref: '#/components/schemas/EventSchedule' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false EventVBAResponse: type: object properties: data: $ref: '#/components/schemas/Event' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ExpenseType: required: - expense_Type type: object properties: expense_Type: maxLength: 16 minLength: 1 type: string description: Name for the expense type. description: maxLength: 512 type: string description: Description of the expense type. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ExpenseTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ExpenseType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ExpenseTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ExpenseType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ExplanationCodeCategory: required: - category - invalid type: object properties: category: maxLength: 6 minLength: 1 type: string description: maxLength: 64 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true invalid: type: boolean update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ExplanationCodeCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ExplanationCodeCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ExplanationCodeCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/ExplanationCodeCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ExplanationCodes: required: - admin_Override - ex_Code - no_Print_On_Remit - override_Denied - override_Pend - patient_Responsibility - print_Only - suppress_EOB_Remit type: object properties: ex_Code: maxLength: 6 minLength: 1 type: string admin_Override: maxLength: 1 minLength: 1 type: string category: maxLength: 6 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true ex_Description: maxLength: 64 type: string nullable: true ex_Result: maxLength: 1 type: string nullable: true hipaA_Code: maxLength: 8 type: string nullable: true hipaA_Group_Code: maxLength: 8 type: string nullable: true long_Description: maxLength: 1024 type: string nullable: true no_Print_On_Remit: maxLength: 1 minLength: 1 type: string override_Denied: type: boolean override_Pend: type: boolean patient_Responsibility: type: boolean print_Only: type: boolean suppress_EOB_Remit: type: boolean update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ExplanationCodesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ExplanationCodes' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ExplanationCodesVBAResponse: type: object properties: data: $ref: '#/components/schemas/ExplanationCodes' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ExternalID: required: - external_ID type: object properties: external_ID: maxLength: 32 minLength: 1 type: string description: External ID that can be selected from a list for Group information entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ExternalIDListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ExternalID' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ExternalIDVBAResponse: type: object properties: data: $ref: '#/components/schemas/ExternalID' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FUNDACCOUNTBALANCELIST: type: object properties: generateRequest: type: integer format: int32 generateFullRequest: type: integer format: int32 candZeroPay: type: integer format: int32 genReqEmail: type: integer format: int32 payor_ID: type: string nullable: true account_Key: type: integer format: int32 nullable: true payor_Name: type: string nullable: true payor_Contact: type: string nullable: true payor_Fax_Number: type: string nullable: true account_Name: type: string nullable: true account_Balance: type: number format: double nullable: true candidate_Balance: type: number format: double nullable: true requested_Balance: type: number format: double nullable: true hold_Balance: type: number format: double nullable: true hold_Count: type: integer format: int32 nullable: true additionalProperties: false FaxReportDTO: type: object properties: parentActivityId: type: string description: Activity ID that spawned this nullable: true when: type: string format: date-time nullable: true onSuccess: $ref: '#/components/schemas/CallbackDTO' onFailure: $ref: '#/components/schemas/CallbackDTO' reportId: type: string description: ID of the Report nullable: true exportType: type: string description: 'Export Type. Valid values are: Excel, Html, Pdf, Word, PPT, CSV' nullable: true siteId: type: string description: "Client specific Site ID within the report server. \r\nThis is typically their Client ID, but may be different based on client needs." nullable: true filename: type: string description: Filename of the report. nullable: true reportParameters: type: object additionalProperties: type: string nullable: true description: "A json object of report parameters\r\nRequired if a report requires them." nullable: true faxNumber: type: string description: Fax destination nullable: true additionalProperties: false FeeSched: required: - fee_Sched - process_Adj_Disc_By_Amount type: object properties: fee_Sched: maxLength: 8 minLength: 1 type: string description: Unique name given to the Fee Scheudle. always_Use_Schedule: maxLength: 1 type: string description: This field is currently informational only. nullable: true description: maxLength: 50 type: string description: A short description of the associated Fee Schedule. nullable: true entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true ex_Code: maxLength: 6 type: string description: Indicates the Ex Code that will be applied to any claim that has been repriced by this ‘Fee Schedule Fee’. nullable: true process_Adj_Disc_By_Amount: type: boolean description: 'Indicates Adjustment and Discount information will be processed based on amount highest to lowest rather than detail line. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false FeeSchedAnesthesia: required: - fee_Sched - feeSchedAnesthesia_Key - from_Value - thru_Value - type type: object properties: feeSchedAnesthesia_Key: type: integer description: 'Unique identifier of this table. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true fee_Sched: maxLength: 8 minLength: 1 type: string description: The fee schedule this anesthesia is associated with. from_Value: maxLength: 8 minLength: 1 type: string description: Starting value of the type. thru_Value: maxLength: 8 minLength: 1 type: string description: Ending value of the type. type: maxLength: 16 minLength: 1 type: string description: 'Determines if the type is Modifier, Procedure, or Place Code.' update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false FeeSchedAnesthesiaListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FeeSchedAnesthesia' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedAnesthesiaVBAResponse: type: object properties: data: $ref: '#/components/schemas/FeeSchedAnesthesia' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedCopy: type: object properties: old_Fee_Sched: type: string nullable: true new_Fee_Sched: type: string nullable: true old_Eff_Date: type: string format: date-time nullable: true new_Eff_Date: type: string format: date-time nullable: true description: type: string nullable: true percent_Change: type: number format: double nullable: true user_ID: type: string nullable: true additionalProperties: false FeeSchedDetail: required: - allowed_Over_Billed - always_Use_Rate - diagnostic_Code_Type - effective_Date - fee_Sched - feeSchedDetail_Key - procedure_Code type: object properties: feeSchedDetail_Key: type: integer description: 'Unique identifier for each Detail record on this Fee Schedule. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 allowed_Over_Billed: type: boolean description: 'This option allows the ‘Fee Schedule’ to price above the billed amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' always_Use_Rate: type: boolean description: 'This field is currently informational only. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' billed_Pct: type: number description: Price based upon a percentage of the billed amount that will be applied to the matching claim detail record through the ‘Fee Schedule’. format: double nullable: true diag_Code: maxLength: 8 type: string description: Requires a matching diagnosis code on the claim for adjudication matching. Start of a range of diagnosis codes when combined with 'Diag Thru'. nullable: true diag_Code_Thru: maxLength: 8 type: string description: End of the diagnosis range when combined with ‘Diag.’. nullable: true diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string description: Indicates the ICD version associated with the selected Diagnosis Codes. drug_Code: maxLength: 32 type: string description: This will require a matching ‘Drug Code’ within a claim line during adjudication. nullable: true effective_Date: type: string description: Date when the schedule should begin applying to claims. This date will be compared to the date of service on the claim. format: date-time entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true ex_Code: maxLength: 6 type: string description: Applies the provided Ex Code to any claim that has been repriced by this ‘Fee Schedule Fee’. nullable: true fee_Sched: maxLength: 8 minLength: 1 type: string description: Unique name given to the Fee Scheudle. from_Age: type: integer description: Starting point for the range of acceptable ages for the Fee Schedule. format: int32 nullable: true from_Units: type: integer description: Starting point for the range of acceptable number of units within a claim for matching during adjudication. format: int32 nullable: true modifier: maxLength: 8 type: string description: Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim. nullable: true modifier2: maxLength: 8 type: string description: Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim. nullable: true modifier3: maxLength: 8 type: string description: Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim. nullable: true modifier4: maxLength: 8 type: string description: Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim. nullable: true no_UC_Percent: type: number description: Price based upon a percentage of the billed amount that is used for Out of Network claims that could not be matched with a usual and customary rate. format: double nullable: true place_Of_Service: maxLength: 5 type: string description: Requires a matching place of service on the claim for adjudication matching. Start of a range of PoS when combined with 'PoS Thru'. nullable: true place_Of_Service_Thru: maxLength: 5 type: string description: End of the PoS range when combined with ‘PoS’. nullable: true price: type: number description: Price that will be applied to the matching claim detail record through the ‘Fee Schedule’. This will be multiplied by the number of units within the claim. format: double nullable: true procedure_Cluster: maxLength: 32 type: string description: This allows the price to be applied to all procedures within a selected procedure cluster. nullable: true procedure_Code: maxLength: 8 minLength: 1 type: string description: 'This section can contain CPT, HCPC, or revenue codes. Every line requires the first procedure code field to be completed, even when using a procedure cluster. Note: If entering a range of codes, the fee entered on that line will apply to all codes in the range.' procedure_Code2: maxLength: 8 type: string description: 'This section can contain CPT, HCPC, or revenue codes. This field is compared to the ''Procedure Code 2'' field on the claim''s detail line.' nullable: true procedure_Code_Thru: maxLength: 8 type: string description: 'This section can contain CPT, HCPC, or Revenue codes. Every line requires the first procedure code field to be completed, even when using a procedure cluster. Note: If entering a range of codes, the fee entered on that line will apply to all codes in the range.' nullable: true provider_Type: maxLength: 10 type: string description: Requires a matching Provider type on the claim for adjudication matching. nullable: true rvS_Units: type: number description: This field is currently informational only. format: double nullable: true specialty_Code: maxLength: 10 type: string description: Requires a matching specialty code on the claim for adjudication matching. nullable: true thru_Age: type: integer description: Ending point for the range of acceptable ages for the Fee Schedule. format: int32 nullable: true thru_Units: type: integer description: Ending point for the range of acceptable number of units within a claim for matching during adjudication. format: int32 nullable: true type_Of_Service: maxLength: 5 type: string description: No longer in use. nullable: true uC_Claim_Type: maxLength: 20 type: string description: 'Allows the User to select an existing rate group to base their pricing upon. For instance, if you are building a ‘Fee Schedule’ that uses a percentage of Medicare rates. These rate groups need to be provided by the User and uploaded by VBA.' nullable: true uC_Percent: type: number description: The desired percentage applied from the selected rate group to the matching claim. format: double nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false FeeSchedDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FeeSchedDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/FeeSchedDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedEffDate: required: - effective_Date - fee_Sched type: object properties: fee_Sched: maxLength: 8 minLength: 1 type: string description: Unique name given to the Fee Scheudle. effective_Date: type: string description: Date when the schedule will begin/began applying to claims. This date will be compared to the date of service on the claim. format: date-time additionalProperties: false FeeSchedEffDateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FeeSchedEffDate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedEffDateVBAResponse: type: object properties: data: $ref: '#/components/schemas/FeeSchedEffDate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FeeSched' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedModifierDiscount: required: - discount_Seq - effective_Date - fee_Sched - feeSchedModifierDiscount_Key type: object properties: feeSchedModifierDiscount_Key: type: integer description: 'Unique identifier assigned to the modifier discount. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 discount_Pct: type: number description: Percentage that the service line will be adjusted after it has been priced by the ‘Fee Schedule’. format: double nullable: true discount_Seq: type: integer description: 'Sequential identifier that determines the order of adjudication for each rule. (Seq. 01 will be applied first and so forth.) Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 effective_Date: type: string description: Date when the discount will begin/began applying to claims. This date will be compared to the date of service on the claim. format: date-time entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true fee_Sched: maxLength: 8 minLength: 1 type: string description: Unique name given to the Fee Scheudle. modifier1: maxLength: 8 type: string description: Identifies modifier codes that should receive the selected discount percentage. nullable: true modifier2: maxLength: 8 type: string description: Identifies modifier codes that should receive the selected discount percentage. nullable: true modifier3: maxLength: 8 type: string description: Identifies modifier codes that should receive the selected discount percentage. nullable: true modifier4: maxLength: 8 type: string description: Identifies modifier codes that should receive the selected discount percentage. nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false FeeSchedModifierDiscountListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FeeSchedModifierDiscount' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedModifierDiscountVBAResponse: type: object properties: data: $ref: '#/components/schemas/FeeSchedModifierDiscount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedModifierExclude: required: - feeSchedModifierExclude_Key - modifier type: object properties: feeSchedModifierExclude_Key: type: integer description: 'Unique identifier assigned to the fee schedule modifier. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true fee_Sched: maxLength: 8 type: string description: Unique name given to the Fee Scheudle. nullable: true modifier: maxLength: 8 minLength: 1 type: string description: Identifies the modifier code that should be excluded. update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false FeeSchedModifierExcludeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FeeSchedModifierExclude' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedModifierExcludeVBAResponse: type: object properties: data: $ref: '#/components/schemas/FeeSchedModifierExclude' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedProcedureGroupAdjust: required: - adjust_Seq - effective_Date - fee_Sched - feeSchedProcedureGroupAdjust_Key - procedure_Code1 - procedure_Code2 - procedure_Group type: object properties: feeSchedProcedureGroupAdjust_Key: type: integer description: 'Unique identifier assigned to the procedure group adjustment. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 adjust_Pct: type: number description: Percentage that the service line will be adjusted after it has been priced by the ‘Fee Schedule’. format: double nullable: true adjust_Repeat: type: integer description: Number of times the associated rule will be applied before moving onto the next sequence. format: int32 nullable: true adjust_Rule: maxLength: 16 type: string description: '[doesn''t exist]' nullable: true adjust_Seq: type: integer description: 'Sequential identifier that determines the order of adjudication for each rule. (Seq. 01 will be applied first and so forth.) Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 effective_Date: type: string description: Date when the adjustment will begin/began applying to claims. This date will be compared to the date of service on the claim. format: date-time entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true fee_Sched: maxLength: 8 minLength: 1 type: string description: Unique name given to the Fee Scheudle. procedure_Code1: type: boolean description: 'Identifies which procedure code field within the claim that adjudication should attempt to match. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' procedure_Code2: type: boolean description: 'Identifies which procedure code field within the claim that adjudication should attempt to match. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' procedure_Group: type: integer description: 'Identifies the procedure group to which the associated rule will be applied. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false FeeSchedProcedureGroupAdjustListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjust' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedProcedureGroupAdjustVBAResponse: type: object properties: data: $ref: '#/components/schemas/FeeSchedProcedureGroupAdjust' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedProviderTypeDiscount: required: - discount_Seq - effective_Date - fee_Sched - feeSchedProviderTypeDiscount_Key type: object properties: feeSchedProviderTypeDiscount_Key: type: integer description: 'Unique identifier assigned to the provider type discount. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 discount_Pct: type: number description: Percentage that the service line will be adjusted after it has been priced by the ‘Fee Schedule’. format: double nullable: true discount_Seq: type: integer description: 'Sequential identifier that determines the order of adjudication for each rule. (Seq. 01 will be applied first and so forth.) Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 effective_Date: type: string description: Date when the discount will begin/began applying to claims. This date will be compared to the date of service on the claim. format: date-time entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true fee_Sched: maxLength: 8 minLength: 1 type: string description: Unique name given to the Fee Scheudle. provider_Type: maxLength: 10 type: string description: Identifies Provider types that should receive the selected discount percentage. nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false FeeSchedProviderTypeDiscountListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FeeSchedProviderTypeDiscount' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedProviderTypeDiscountVBAResponse: type: object properties: data: $ref: '#/components/schemas/FeeSchedProviderTypeDiscount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FeeSchedVBAResponse: type: object properties: data: $ref: '#/components/schemas/FeeSched' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Feedback: required: - description - issue_Type - screen type: object properties: screen: maxLength: 256 minLength: 1 type: string description: 'Represents the specific screen from which feedback is submitted. This attribute serves as a contextual identifier, aiding in the precise location of user feedback within the application.' issue_Type: maxLength: 256 minLength: 1 type: string description: Categorizes the type of the issue or feedback being reported. It provides valuable context regarding the specific problem or concern encountered. description: maxLength: 1024 minLength: 1 type: string description: 'Provides a textual representation of the feedback or issue reported. It allows users to elaborate on their experiences, providing essential details, observations, or suggestions related to the reported concern.' logs: maxLength: 2048 type: string description: 'Refers to any relevant log files or records associated with the reported issue or feedback. These logs provide valuable technical data and context, aiding in the investigation and resolution of complex issues.' nullable: true additionalProperties: false Field: required: - name - type type: object properties: name: minLength: 1 type: string type: minLength: 1 type: string additionalProperties: false FieldMap: required: - columnIndex - columnName - tableName type: object properties: tableName: minLength: 1 type: string description: 'Name of the table from which this value originates,' columnName: minLength: 1 type: string description: Column name from which this value originates. columnIndex: type: integer description: Pointer to this value within each of the returned Rows. format: int32 additionalProperties: false description: Describes the values returned in the Rows. FileDetail: type: object properties: url: type: string nullable: true sha512: type: string nullable: true size: type: integer format: int64 additionalProperties: false Filter: required: - filter_Key type: object properties: filter_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true filter_Description: type: string nullable: true filter_Type: maxLength: 32 type: string nullable: true filter_Value: type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false FilterListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Filter' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FilterType: required: - filter_Type type: object properties: filter_Type: maxLength: 32 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true filterType_Description: type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false FilterTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FilterType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FilterTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/FilterType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FilterVBAResponse: type: object properties: data: $ref: '#/components/schemas/Filter' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FlexIssuanceType: required: - flex_Vendor - issuance_Type type: object properties: flex_Vendor: maxLength: 32 minLength: 1 type: string description: Identifier of the flex vendor issuance_Type: maxLength: 32 minLength: 1 type: string description: Identifier of the issuance type description: maxLength: 512 type: string description: Description of the issuance type nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FlexIssuanceTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FlexIssuanceType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FlexIssuanceTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/FlexIssuanceType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FlexVendor: required: - flex_Vendor type: object properties: flex_Vendor: maxLength: 32 minLength: 1 type: string description: Name for the flex vendor. description: maxLength: 512 type: string description: Description of the flex vendor. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FlexVendorCardStatus: required: - card_Status - flex_Vendor type: object properties: flex_Vendor: maxLength: 32 minLength: 1 type: string description: ID of the flex vendor. card_Status: maxLength: 32 minLength: 1 type: string description: Name for the vendor card status. description: maxLength: 512 type: string description: Description of the vender card status. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FlexVendorCardStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FlexVendorCardStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FlexVendorCardStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/FlexVendorCardStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FlexVendorListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FlexVendor' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FlexVendorPurseStatus: required: - flex_Vendor - purse_Status type: object properties: flex_Vendor: maxLength: 32 minLength: 1 type: string description: ID of the flex vendor. purse_Status: maxLength: 32 minLength: 1 type: string description: Name for the vendor purse status. description: maxLength: 512 type: string description: Description of the vendor purse status. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FlexVendorPurseStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FlexVendorPurseStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FlexVendorPurseStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/FlexVendorPurseStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FlexVendorVBAResponse: type: object properties: data: $ref: '#/components/schemas/FlexVendor' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ForfeitureStatus: required: - default_Status - forfeiture_Status type: object properties: forfeiture_Status: maxLength: 32 minLength: 1 type: string description: Name for the forfeiture status. default_Status: type: boolean description: 'Identifies that the forfeiture status will be assigned by default. Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 256 type: string description: Description of the forfeiture status. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ForfeitureStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ForfeitureStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ForfeitureStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ForfeitureStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FunctionalArea: required: - description - name type: object properties: name: maxLength: 64 minLength: 1 type: string description: Unique name of the Functional Area description: maxLength: 512 minLength: 1 type: string description: Description of the Functional Area additionalProperties: false FunctionalAreaListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FunctionalArea' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Funding: required: - funding_Key type: object properties: funding_Key: type: integer description: 'ID of the Funding record. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 account_Key: type: integer description: ID of the funding account. format: int32 nullable: true cleared_Amount: type: number description: Amount that was Cleared. format: double nullable: true cleared_Date: type: string description: Date the Amount was Cleared. format: date-time nullable: true deposit_Key: type: integer description: ID of the Deposit. format: int32 nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true funding_Status: maxLength: 32 type: string description: Status of the Funding. nullable: true funding_Type: maxLength: 32 type: string description: Type of the Funding. nullable: true issue_Amount: type: number description: Amount Issued of the Funding record. format: double nullable: true issue_Date: type: string description: Date of the Issue. format: date-time nullable: true issue_ID: maxLength: 32 type: string description: ID of the Issue. nullable: true issue_Name: maxLength: 64 type: string description: Name of the Issue. nullable: true issue_Type: maxLength: 32 type: string description: The transaction type of the Issue Amount. nullable: true payor_ID: maxLength: 20 type: string description: ID of the Payor associated with the Funding record. nullable: true received_Date: type: string description: Date Funding was Received. format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingAccount: required: - account_Key - use_ACH_Numbering type: object properties: account_Key: type: integer description: 'ID of the funding account. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 acH_Number_Prefix: maxLength: 8 type: string description: Identifies the prefix of the ACH number. nullable: true acH_Number_Suffix: maxLength: 8 type: string description: Identifies the suffix of the ACH number. nullable: true account_Category: maxLength: 8 type: string description: Identifies which category the funding account belongs to. nullable: true account_Name: maxLength: 64 type: string description: Name for the funding account. nullable: true account_Number: maxLength: 32 type: string description: Account number of the funding account. nullable: true account_Type: maxLength: 8 type: string description: Identifies the type of funding account. 'Account Types' are configured within 'Accounting Configuration'. nullable: true bank_Address1: maxLength: 128 type: string description: Address line 1 of the funding account's banking institution. nullable: true bank_Address2: maxLength: 128 type: string description: Address line 2 of the funding account's banking institution. nullable: true bank_City: maxLength: 32 type: string description: City of the banking institution's address. nullable: true bank_Country_ID: maxLength: 8 type: string description: Identifies the country that the funding account belongs to. nullable: true bank_Name: maxLength: 64 type: string description: Name of the funding account's banking institution. nullable: true bank_State: maxLength: 2 type: string description: State of the banking institution's address. nullable: true bank_Zip: maxLength: 16 type: string description: Zip Code of the banking institution's address. nullable: true cC_Address1: maxLength: 128 type: string description: Address Line 1 used for the credit card. nullable: true cC_Address2: maxLength: 128 type: string description: Address Line 2 used for the credit card. nullable: true cC_City: maxLength: 32 type: string description: City used for the credit card. nullable: true cC_Debit_Credit: maxLength: 8 type: string description: Identifies the card as either a debit card or credit card. nullable: true cC_Exp_Month: type: integer description: Expiration month of the credit card. format: int32 nullable: true cC_Exp_Year: type: integer description: Expiration year of the credit card. format: int32 nullable: true cC_Name_On_Card: maxLength: 128 type: string description: Identifies the name listed on the credit card. nullable: true cC_Number: maxLength: 32 type: string description: Credit card number. nullable: true cC_Sec_Code: type: integer description: Security code used for the credit card. format: int32 nullable: true cC_State: maxLength: 2 type: string description: State used for the credit card. nullable: true cC_Type: maxLength: 16 type: string description: Identifies the type of credit card used by the funding account. nullable: true cC_Zip: maxLength: 16 type: string description: Zip code used for the credit card. nullable: true currency_ID: maxLength: 16 type: string description: Indicates what current the funding account uses. nullable: true default_Check_Stock: type: integer description: Assigns the default check stock for generated checks. format: int32 nullable: true default_Funding_Threshold: type: integer description: Assigns the default funding threshold. format: int32 nullable: true effective_Date: type: string description: Date when the funding account becomes/became effective. format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true ex_Code: maxLength: 6 type: string description: Ex Code that will be applied to claims which are funded by this account. nullable: true federal_ID: maxLength: 20 type: string description: Identifies the Federal Tax ID of the funding account. nullable: true fractional_Routing_Number: maxLength: 32 type: string description: Fractional routing number of the funding account. nullable: true last_ACH_Number: type: integer description: Number of the last generated ACH transaction from the funding account. format: int32 nullable: true last_Check_Number: type: integer description: Number of the last generated check from the funding account. format: int64 nullable: true micR_Check_Num_Start_Pos: type: integer description: Identifies the starting number for the funding account's Magnietic Ink Character Recognition checks. format: int32 nullable: true micR_Line: maxLength: 128 type: string description: Identifies the Magnetic Ink Character Recognition line of the funding account's checks. nullable: true positive_Pay_Required: type: boolean description: Used to determine if a positive payment is required. nullable: true routing_Number: maxLength: 32 type: string description: Routing number of the funding account. nullable: true security_Code: maxLength: 8 type: string description: Identifies the security code of the funding account. nullable: true statement_Format_Key: type: integer description: Indicates the format for generated statements. format: int32 nullable: true swift_Code: maxLength: 20 type: string description: Identifies the swift code of the funding account. nullable: true term_Date: type: string description: Date when the funding account expires/expired. format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true use_ACH_Numbering: type: boolean description: 'Used to determine if checks are numbered by ACH. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false FundingAccountBalance: type: object properties: payor_ID: type: string nullable: true account_Key: type: integer format: int32 nullable: true account_Balance: type: number format: double nullable: true account_Cleared_Balance: type: number format: double nullable: true issue_Amount: type: number format: double nullable: true cleared_Amount: type: number format: double nullable: true void_Amount: type: number format: double nullable: true deposit_Amount: type: number format: double nullable: true check_Paid_Amount: type: number format: double nullable: true check_Cleared_Amount: type: number format: double nullable: true check_Void_Amount: type: number format: double nullable: true additionalProperties: false FundingAccountBalanceVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingAccountBalance' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingAccountCategory: required: - account_Category type: object properties: account_Category: maxLength: 8 minLength: 1 type: string description: Name of the 'Funding Account Category'. description: maxLength: 64 type: string description: Description of the 'Funding Account Category'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingAccountCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingAccountCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingAccountCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingAccountCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingAccountListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingAccount' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingAccountSignature: required: - account_Key - effective_Date - fundingAccountSignature_Key - signature_Key type: object properties: fundingAccountSignature_Key: type: integer description: 'ID of the funding account signature. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 account_Key: type: integer description: 'ID of the account which the signature is associated with. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 effective_Date: type: string description: 'Date when the signature becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true signature_Key: type: integer description: 'ID of the signature. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 term_Date: type: string description: Date when the signature expires/expired. format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingAccountSignatureListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingAccountSignature' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingAccountSignatureVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingAccountSignature' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingAccountType: required: - account_Type type: object properties: account_Type: maxLength: 8 minLength: 1 type: string description: Name of the 'Funding Account Type'. description: maxLength: 64 type: string description: Description of the 'Funding Account Type'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingAccountTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingAccountType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingAccountTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingAccountType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingAccountVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingAccount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingDeposit: required: - deposit_Key type: object properties: deposit_Key: type: integer description: 'ID of the funding deposit. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 deposit_Date: type: string description: Date when the deposit occurred. format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true reconcile_Key: type: integer description: ID of the reconciliation associated with the deposit. format: int32 nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingDepositListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingDeposit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingDepositVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingDeposit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingIndicator: required: - funding_Indicator type: object properties: funding_Indicator: maxLength: 1 minLength: 1 type: string description: Name of the 'Funding Indicator'. description: maxLength: 200 type: string description: Description of the 'Funding Indicator'. nullable: true additionalProperties: false FundingIndicatorListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingIndicator' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingIndicatorVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingIndicator' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingIssueType: required: - issue_Type type: object properties: issue_Type: maxLength: 32 minLength: 1 type: string description: Name of the 'Funding Issue Type'. description: maxLength: 64 type: string description: Description of the 'Funding Issue Type'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingIssueTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingIssueType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingIssueTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingIssueType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Funding' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingNameOnCheck: required: - pay_To_ID - send_Check_To type: object properties: send_Check_To: minLength: 1 type: string pay_To_ID: minLength: 1 type: string subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true name_On_Check: type: string nullable: true address_On_Check: type: string nullable: true address2_On_Check: type: string nullable: true city_On_Check: type: string nullable: true state_On_Check: type: string nullable: true zip_On_Check: type: string nullable: true country_ID_On_Check: type: string nullable: true name_On_Address: type: string nullable: true additionalProperties: false FundingNameOnCheckVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingNameOnCheck' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingProcessCheck: type: object properties: posted_Date: type: string format: date-time nullable: true user_ID: type: string nullable: true process_Check_Options: type: array items: $ref: '#/components/schemas/ProcessCheckOption' nullable: true additionalProperties: false FundingProcessClaimRefund: type: object properties: refund_Funding_Key: type: integer format: int32 claim_Number: type: integer format: int32 refund_Batch_Number: type: integer format: int32 reenter_Claim: type: boolean backout_Ex_Code: type: string nullable: true reentry_Ex_Code: type: string nullable: true user_ID: type: string nullable: true additionalProperties: false FundingReconcile: required: - account_Key - electronic_Statement - reconcile_Date - reconcile_Key - reconcile_User type: object properties: reconcile_Key: type: integer description: 'ID of the reconciliation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 account_Key: type: integer description: 'ID of the account associated with the reconciliation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 begin_Balance: type: number description: Beginning balance of the reconciliation format: double nullable: true begin_Date: type: string description: Beginning Date of the reconciliation. format: date-time nullable: true electronic_Statement: type: boolean description: 'Indicates that the associated reconciliation has an electronic statement. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true reconcile_Date: type: string description: 'Date when the reconciliation occurred. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time reconcile_Status: maxLength: 32 type: string description: Most recent status of the reconciliation. 'Reconcile Statuses' are configured within 'Accounting Configuration'. nullable: true reconcile_User: maxLength: 32 minLength: 1 type: string description: User associated with the reconciliation statement_Balance: type: number description: Balance of the reconciliation statement format: double nullable: true statement_Date: type: string description: Date when the statement associated with the reconciliation was submitted. format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingReconcileDisbursed: required: - check_ID - reconcile_Key - selected type: object properties: reconcile_Key: type: integer description: 'ID of the reconciliation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 check_ID: type: integer description: 'ID of the check being used for the disbursement. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true selected: type: boolean description: 'Indicates if the check was selected. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingReconcileDisbursedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingReconcileDisbursed' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingReconcileDisbursedVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingReconcileDisbursed' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingReconcileListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingReconcile' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingReconcileOnStatement: required: - on_Statement_Key - reconcile_Key - selected type: object properties: on_Statement_Key: type: integer description: 'ID of the reconciliation offset. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true issue_Amount: type: number description: Offset amount used for the funding reconciliation. format: double nullable: true issue_Date: type: string description: Date when the associated issue was created. format: date-time nullable: true issue_ID: maxLength: 32 type: string description: ID of the issue associated with the funding reconciliation. nullable: true issue_Type: maxLength: 32 type: string description: Issue Type' associated with the funding reconciliation. 'Funding Issue Types' are configured within 'Accounting Configuration'. nullable: true payor_ID: maxLength: 20 type: string description: ID of the Payor being used for the associated reconciliation. nullable: true reconcile_Key: type: integer description: 'ID of the reconciliation associated with the offset. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 reconcile_Type: maxLength: 32 type: string description: Indicates whether the associated offset is a credit or a debit. nullable: true selected: type: boolean description: 'Indicates that this offest will be applied to the current reconciliation when the User selects ''Update''. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingReconcileOnStatementListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingReconcileOnStatement' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingReconcileOnStatementVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingReconcileOnStatement' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingReconcileReceived: required: - deposit_Key - reconcile_Key - selected type: object properties: reconcile_Key: type: integer description: 'ID of the reconciliation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 deposit_Key: type: integer description: 'ID of the deposit. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true selected: type: boolean description: 'Flag to indicated if the record is Selected. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingReconcileReceivedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingReconcileReceived' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingReconcileReceivedVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingReconcileReceived' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingReconcileStatus: required: - reconcile_Status type: object properties: reconcile_Status: maxLength: 32 minLength: 1 type: string description: Name of the 'Funding Reconcile Status'. description: maxLength: 64 type: string description: Description of the 'Funding Reconcile Status'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingReconcileStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingReconcileStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingReconcileStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingReconcileStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingReconcileVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingReconcile' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingReference: required: - funding_Key - request_Key type: object properties: request_Key: type: integer description: 'ID of the request. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 funding_Key: type: integer description: 'ID of the funding. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true reference_Type: maxLength: 32 type: string description: Type of the funding reference. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingReferenceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingReference' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingReferenceVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingReference' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingRequest: required: - request_Date - request_Key - request_User type: object properties: request_Key: type: integer description: 'ID of the funding request. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 account_Key: type: integer description: ID of the Account associated with the funding request. format: int32 nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true funding_Format: maxLength: 32 type: string description: Format of the funding request. nullable: true invalid_Request: type: boolean description: Indicates that the funding request is invalid. nullable: true payor_ID: maxLength: 20 type: string description: ID of the Payor associated with the funding request. nullable: true primary_Contact_Method: maxLength: 32 type: string description: Method of the funding request. nullable: true request_Amount: type: number description: Amount of the funding request. format: double nullable: true request_Date: type: string description: Date when the funding request was submitted. format: date-time request_Status: maxLength: 32 type: string description: Indicates the 'Request Status' of the funding request. 'Request Types' are configured within 'Accounting Configuration'. nullable: true request_Type: maxLength: 32 type: string description: Indicates the 'Request Type' of the funding request. 'Request Types' are configured within 'Accounting Configuration'. nullable: true request_User: maxLength: 32 minLength: 1 type: string description: ID of the User who submitted the funding request. update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingRequestClaim: required: - batch_Claim - batch_Number - funded - request_Key type: object properties: batch_Number: type: integer description: 'Batch number of the claim associated with the funding request. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 batch_Claim: type: integer description: 'Claim number of the claim associated with the funding request. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 request_Key: type: integer description: 'ID of the funding request. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true funded: type: boolean description: 'Indicates that the claim has been funded. Note: This field is marked as NOT NULL in the database and therefore required by the API.' funded_Amount: type: number description: Amount that was funded. format: double nullable: true funded_Date: type: string description: Date when the claim was funded. format: date-time nullable: true request_Amount: type: number description: Amount of the funding request. format: double nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingRequestClaimListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingRequestClaim' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingRequestClaimVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingRequestClaim' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingRequestListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingRequest' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingRequestStatus: required: - request_Status type: object properties: request_Status: maxLength: 32 minLength: 1 type: string description: Name of the 'Request Status'. description: maxLength: 64 type: string description: Description of the 'Request Status'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingRequestStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingRequestStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingRequestStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingRequestStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingRequestType: required: - request_Type type: object properties: request_Type: maxLength: 32 minLength: 1 type: string description: Name of the 'Request Type'. description: maxLength: 64 type: string description: Description of the 'Request Type'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingRequestTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingRequestType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingRequestTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingRequestType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingRequestVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingRequest' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingServiceSatisfyRequest: type: object properties: request_Key: type: integer format: int32 funding_Key: type: integer format: int32 new_Request: type: boolean user_ID: type: string nullable: true candidateClaims: type: array items: $ref: '#/components/schemas/CandidateClaim' nullable: true additionalProperties: false FundingStatement: type: object properties: reconcile_Key: type: integer format: int32 nullable: true account_Key: type: integer format: int32 begin_Date: type: string format: date-time nullable: true begin_Balance: type: number format: double nullable: true statement_Date: type: string format: date-time nullable: true statement_Balance: type: number format: double nullable: true user_ID: type: string nullable: true electronic_Statements: type: array items: $ref: '#/components/schemas/ElectronicStatement' nullable: true additionalProperties: false FundingStatementFormat: required: - statement_Format_Key type: object properties: statement_Format_Key: type: integer description: 'ID of the statement_format. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 business_Object: maxLength: 64 type: string description: Object of the funding statement format. nullable: true description: maxLength: 64 type: string description: Description of the funding statement format. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true format: maxLength: 32 type: string description: Format of the funding statement format. nullable: true length: type: integer description: ID of the length. format: int32 nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingStatementFormatListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingStatementFormat' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingStatementFormatVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingStatementFormat' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingStatus: required: - funding_Status type: object properties: funding_Status: maxLength: 32 minLength: 1 type: string description: Name of the 'Funding Status'. description: maxLength: 64 type: string description: Description of the 'Funding Status'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingTransferFunds: type: object properties: payor_ID: type: string nullable: true account_Key: type: integer format: int32 nullable: true issue_Amount: type: number format: double nullable: true issue_Type: type: string nullable: true issue_ID: type: string nullable: true issue_Name: type: string nullable: true issue_Date: type: string format: date-time nullable: true received_Date: type: string format: date-time nullable: true funding_Type: type: string nullable: true transfer_Funding_Type: type: string nullable: true transfer_Payor_ID: type: string nullable: true transfer_Account_Key: type: integer format: int32 nullable: true create_Check: type: boolean expense_Type: type: string nullable: true payee_ID: type: string nullable: true user_ID: type: string nullable: true additionalProperties: false FundingType: required: - funding_Type type: object properties: funding_Type: maxLength: 32 minLength: 1 type: string description: Name of the 'Funding Type'. description: maxLength: 64 type: string description: Description of the 'Funding Type'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false FundingTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FundingType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/FundingType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingVBAResponse: type: object properties: data: $ref: '#/components/schemas/Funding' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false FundingVoidCheck: type: object properties: check_ID: type: integer format: int32 reentry_Batch_Number: type: integer format: int32 nullable: true backout_Ex_Code: type: string nullable: true reentry_Ex_Code: type: string nullable: true reentry_Provider_ID: type: string nullable: true reentry_Subscriber_ID: type: string nullable: true reentry_Member_Seq: type: string nullable: true user_ID: type: string nullable: true additionalProperties: false Gender: required: - gender_Code type: object properties: gender_Code: maxLength: 1 minLength: 1 type: string description: User defined Gender Code for each gender value. description: maxLength: 512 type: string description: Brief description of this Gender Code. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 200 type: string description: User that first added the record to the system nullable: true hipaA_Code: maxLength: 8 type: string description: Used to map to a valid x12 transaction value for 834 processing. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false GenderListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Gender' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GenderVBAResponse: type: object properties: data: $ref: '#/components/schemas/Gender' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GeneratePremInvoice: type: object properties: invoice_Key: type: integer format: int32 nullable: true group_ID: type: string nullable: true division_ID: type: string nullable: true subscriber_ID: type: string nullable: true bill_From: type: string format: date-time nullable: true bill_Thru: type: string format: date-time nullable: true invoice_Date: type: string format: date-time nullable: true due_Date: type: string format: date-time nullable: true user_ID: type: string nullable: true regenerate: type: boolean input_Date: type: string format: date-time nullable: true additionalProperties: false GenerateReinsTransaction: type: object properties: return_Code: type: integer format: int32 nullable: true return_Message: type: string nullable: true trans_Created_Count: type: integer format: int32 nullable: true additionalProperties: false GenerateReinsTransactionVBAResponse: type: object properties: data: $ref: '#/components/schemas/GenerateReinsTransaction' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GetPremDistributionListResult: type: object properties: selected: type: integer format: int32 nullable: true group_ID: type: string nullable: true payor_ID: type: string nullable: true account_Key: type: integer format: int32 nullable: true group_Name: type: string nullable: true payor_Name: type: string nullable: true account_Name: type: string nullable: true last_Distribution_Date: type: string format: date-time nullable: true distribution_Amount: type: number format: double nullable: true additionalProperties: false GetPremDistributionListResultListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GetPremDistributionListResult' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GetPremInvoiceSubscriberListResult: type: object properties: invoice_Key: type: integer description: Unique identifier for the invoice. format: int32 group_ID: type: string description: Identifier for the group associated with the invoice. nullable: true division_ID: type: string description: Identifier for the division within the group. nullable: true subscriber_ID: type: string description: Identifier for the subscriber. nullable: true subscriber_Name: type: string description: Name of the subscriber. nullable: true premium: type: number description: Total premium amount for the invoice. format: double adjustment: type: number description: Adjustment amount applied to the invoice. format: double received: type: number description: Total amount received for the invoice. format: double due: type: number description: Total amount due for the invoice. Due = (Premium + Adjustment) - Received format: double premium_Waived: type: boolean description: Flag indicating whether the premium was waived. dependent_Count: type: integer description: Count of dependents associated with the subscriber. format: int32 member_Count: type: integer description: Total count of members (subscriber and dependents). format: int32 premium_Waived_Calc: type: integer description: Calculated value indicating whether the premium was waived. format: int32 additionalProperties: false GetPremInvoiceSubscriberListResultListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GetPremInvoiceSubscriberListResult' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Grievance: required: - grievance_Key type: object properties: grievance_Key: type: integer description: 'ID number of the grievance. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 admin_Change: maxLength: 4096 type: string description: Area where the User may describe the administrative change. nullable: true admin_Change_Date: type: string description: Date when the administrative change took place. format: date-time nullable: true admin_Change_Type: maxLength: 32 type: string description: Type of change that was made by Administration. 'Admin. Change Types' are configured within 'Grievance Configuration'. nullable: true call_Key: type: integer description: ID of the call from which the grievance was submitted. format: int32 nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true grievance_Category: maxLength: 32 type: string description: Category of the grievance. 'Greivance Categories' are configured within 'Grievance Configuration'. nullable: true grievance_Filed: type: string description: Date when the grievance was viewed and filed by an Administartor. format: date-time nullable: true grievance_Received: type: string description: Date when the grievance was submitted. format: date-time nullable: true grievance_Resolved: type: string description: Date when the grievance was resolved. format: date-time nullable: true grievance_Source: maxLength: 16 type: string description: ID of the source of the grievance. nullable: true grievance_Status: maxLength: 32 type: string description: Status of the grievance. 'Greivance Statuses' are configured within 'Grievance Configuration'. nullable: true grievance_Type: maxLength: 32 type: string description: Type of the grievance. 'Grievance Types' are configured within 'Grievance Configuration'. nullable: true issue: maxLength: 4096 type: string description: Area where the User may describe the issue. nullable: true issue_Date: type: string description: Date when the issue occurred. format: date-time nullable: true issue_Type: maxLength: 32 type: string description: Type of issue the grievance is associated with. 'Issue Types' are configured within 'Grievance Configuration'. nullable: true member_Seq: maxLength: 2 type: string description: Sequential identifier of the Member associated with the grievance. nullable: true patient_Account_Number: maxLength: 64 type: string description: Account number of the Patient associated with the grievance. nullable: true provider_ID: maxLength: 20 type: string description: ID of the Provider associated with the grievance. nullable: true resolution: maxLength: 4096 type: string description: Area where the User may describe the resolution. nullable: true resolution_Date: type: string description: Date when the resolution was implemented. format: date-time nullable: true resolution_Type: maxLength: 32 type: string description: Type of resolution used to address the grievance. 'Resolution Types' are configured within 'Grievance Configuration'. nullable: true subscriber_ID: maxLength: 9 type: string description: Unique system assigned number for the Subscriber nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false GrievanceAdminChangeType: required: - default_Admin_Change_Type - grievance_Admin_Change_Type type: object properties: grievance_Admin_Change_Type: maxLength: 32 minLength: 1 type: string description: Name given to the 'Admin. Change Type'. default_Admin_Change_Type: type: boolean description: 'Checking this option will automatically apply this ''Admin. Change Type'' to new grievances. Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 256 type: string description: Description of the 'Admin. Change Type'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false GrievanceAdminChangeTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GrievanceAdminChangeType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GrievanceAdminChangeTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/GrievanceAdminChangeType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GrievanceCategory: required: - default_Category - grievance_Category type: object properties: grievance_Category: maxLength: 32 minLength: 1 type: string description: Name given to the 'Category'. default_Category: type: boolean description: 'Checking this option will automatically apply this ''Category'' to new grievances. Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 256 type: string description: Description of the 'Category'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false GrievanceCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GrievanceCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GrievanceCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/GrievanceCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GrievanceFiling: type: object properties: grievance_Source: type: string nullable: true subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true provider_ID: type: string nullable: true auth_Number: type: string nullable: true call_Key: type: integer format: int32 nullable: true claim_Number: type: integer format: int32 nullable: true user_ID: type: string nullable: true additionalProperties: false GrievanceIssueType: required: - default_Issue_Type - grievance_Issue_Type type: object properties: grievance_Issue_Type: maxLength: 32 minLength: 1 type: string description: Name given to the 'Issue Type'. default_Issue_Type: type: boolean description: 'Checking this option will automatically apply this ''Issue Type'' to new grievances. Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 256 type: string description: Description of the 'Issue Type'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false GrievanceIssueTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GrievanceIssueType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GrievanceIssueTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/GrievanceIssueType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GrievanceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Grievance' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GrievanceResolutionType: required: - default_Resolution_Type - grievance_Resolution_Type type: object properties: grievance_Resolution_Type: maxLength: 32 minLength: 1 type: string description: Name given to the 'Resolution Type'. default_Resolution_Type: type: boolean description: 'Checking this option will automatically apply this ''Resolution Type'' to new grievances. Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 256 type: string description: Description of the 'Resolution Type'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false GrievanceResolutionTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GrievanceResolutionType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GrievanceResolutionTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/GrievanceResolutionType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GrievanceStatus: required: - default_Status - grievance_Status type: object properties: grievance_Status: maxLength: 32 minLength: 1 type: string description: Name of the 'Grievance Status'. default_Status: type: boolean description: 'Checking this option will automatically apply this ''Status'' to new grievances. Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 256 type: string description: Description of the 'Grievance Status'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false GrievanceStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GrievanceStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GrievanceStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/GrievanceStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GrievanceType: required: - default_Type - grievance_Type type: object properties: grievance_Type: maxLength: 32 minLength: 1 type: string description: Name of the 'Grievance Type'. default_Type: type: boolean description: 'Checking this option will automatically apply this ''Grievance Type'' to new grievances. Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 256 type: string description: Description of the 'Grievance Type'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false GrievanceTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GrievanceType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GrievanceTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/GrievanceType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GrievanceVBAResponse: type: object properties: data: $ref: '#/components/schemas/Grievance' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupACHPull: required: - acH_Pull_Day - group_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References the Groups.Group_ID value on the parent record. acH_Pull_Day: type: integer description: 'Day the ACH transaction occurs Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupACHPullListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupACHPull' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupACHPullVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupACHPull' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupATP: required: - group_ID - groupATP_Key type: object properties: groupATP_Key: type: integer format: int32 claim_Type: maxLength: 20 type: string nullable: true division_ID: maxLength: 20 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true federal_ID: maxLength: 20 type: string nullable: true group_ID: maxLength: 20 minLength: 1 type: string place_Of_Service_From: maxLength: 5 type: string nullable: true place_Of_Service_Thru: maxLength: 5 type: string nullable: true provider_NPI: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false GroupATPListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupATP' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupATPVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupATP' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupAccountPeriod: required: - group_ID - groupAccountPeriod_Key type: object properties: groupAccountPeriod_Key: type: integer description: 'Unique identifier for each effective period on this account setting. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 division_ID: maxLength: 20 type: string description: References GroupDivision.Division_ID value on the parent record. nullable: true effective_Date: type: string description: Date when the Group Account Period becomes/became effective. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: References GroupDivision.Group_ID value on the parent record. term_Date: type: string description: Date when the Group Account Period expires/expired. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupAccountPeriodListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupAccountPeriod' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupAccountPeriodVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupAccountPeriod' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupAccountReport: required: - account_Key - group_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References Groups.Group_ID value on parent record. account_Key: type: integer description: 'References PayorAccount.Account_Key value on parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true payor_ID: maxLength: 20 type: string description: References PayorAccount.Payor_ID value on parent record. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupAccountReportListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupAccountReport' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupAccountReportVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupAccountReport' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupAddContract: type: object properties: contract: $ref: '#/components/schemas/GroupContract' reenroll: type: boolean reenrollPlan: type: boolean reenrollRider: type: boolean copyPlan: type: boolean copyNetwork: type: boolean copyTier: type: boolean copyRider: type: boolean reenrollRiderIDCode: type: boolean copyPlanIDCode: type: boolean copyNetworkIDCode: type: boolean user_ID: type: string nullable: true planMappings: type: array items: $ref: '#/components/schemas/PlanMapping' nullable: true additionalProperties: false GroupBillCyclePaymentMethod: required: - groupBillCyclePaymentMethod_Key type: object properties: groupBillCyclePaymentMethod_Key: type: integer description: 'Unique identifier for the Group Billing Cycle Payment Method Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 billing_Cycle_ID: maxLength: 2 type: string description: Unique identifier for the Billing Cycle nullable: true division_ID: maxLength: 20 type: string description: Unique ID for the Division nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true group_ID: maxLength: 20 type: string description: Unique ID for the Group nullable: true payment_Method: maxLength: 20 type: string description: The primary key of the payment method nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupBillCyclePaymentMethodListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupBillCyclePaymentMethod' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupBillCyclePaymentMethodVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupBillCyclePaymentMethod' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupChangeCoverageStart: type: object properties: contract: $ref: '#/components/schemas/GroupContract' new_Coverage_Start: type: string format: date-time user_ID: type: string nullable: true disable_Enrollment_Update: type: boolean additionalProperties: false GroupClass: required: - class_Code - cobra - group_ID - groupDivisionClass_Key - smart_Flex type: object properties: groupDivisionClass_Key: type: integer description: 'Unique identifier for each Claim record within this Group/Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 cobra: type: boolean description: 'Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.' calc_Cov_By: maxLength: 8 type: string description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. nullable: true class_Code: maxLength: 32 minLength: 1 type: string description: The Class indicator assigned to this class record within the Group/Division setup. division_ID: maxLength: 20 type: string description: References GroupDivision.Division_ID value on the parent record. nullable: true effective_Date: type: string description: Effective (Start) date of this Class on this Group/Division. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: References GroupDivision.Group_ID value on the parent record. max_Amount: type: number description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. format: double nullable: true max_Guaranteed_Issue: type: number description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. format: double nullable: true max_Volume: type: number description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. format: double nullable: true min_Amount: type: number description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. format: double nullable: true min_Volume: type: number description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. format: double nullable: true multiplier_Option: maxLength: 8 type: string description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. nullable: true pay_Freq: type: integer description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. format: int32 nullable: true pay_Freq_Start: type: string description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. format: date-time nullable: true pay_Freq_Type: maxLength: 8 type: string description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. nullable: true plan_ID: maxLength: 20 type: string description: If this class definition is Plan specific then add a reference here to Plans.Plan_ID. nullable: true smart_Flex: type: boolean description: 'Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.' start_Date_Rule: maxLength: 8 type: string description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. nullable: true term_Date: type: string description: Term (End) date of this Class on this Group/Division. format: date-time nullable: true term_Rule: maxLength: 8 type: string description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true volume_Increment: type: number description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. format: double nullable: true waiting_Period: type: integer description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. format: int32 nullable: true waiting_Period_Type: maxLength: 8 type: string description: Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. nullable: true additionalProperties: false GroupClassListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupClass' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupClassVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupClass' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupCompanyDataExCodeOverride: required: - companyData_Ex_Code_Field - group_ID - groupCompanyDataExCodeOverride_Key type: object properties: groupCompanyDataExCodeOverride_Key: type: integer description: 'Unique identifier for each Ex Code override configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 companyData_Ex_Code_Field: maxLength: 128 minLength: 1 type: string description: Indicates the Ex_Code field on CompanyData that is having an override applied for this Group/Division. division_ID: maxLength: 20 type: string description: References GroupDivision.Division_ID value on the parent record. nullable: true entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: References GroupDivision.Group_ID value on the parent record. override_Ex_Code: maxLength: 6 type: string description: References ExplanationCodes.Ex_Code and is the override value that is used instead of the setting on CompanyData during adjudication. nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false GroupCompanyDataExCodeOverrideListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupCompanyDataExCodeOverride' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupCompanyDataExCodeOverrideVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupCompanyDataExCodeOverride' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupContract: required: - advice_To_Pay - benefit_At_Member - comm_Pct_Flag - coverage_Start - division_ID - group_ID - max_At_Subscriber - rider_At_Member - salaried_Benefit - total_At_Member type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupDivision.Group_ID value on the parent record. division_ID: maxLength: 20 minLength: 1 type: string description: References GroupDivision.Division_ID value on the parent record. coverage_Start: type: string description: 'Date when the contract becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time adult_Age: type: integer description: Identifies the age at which dependents are considered to be adults. Student status information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here. format: int32 nullable: true advice_To_Pay: type: boolean description: 'When this option is selected, adjudication to mark every claim as ''Advice to Pay'' (ATP). Advice to Pay claims do not produce check records when processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' allow_Multi_Plan: maxLength: 1 type: string description: No longer in use. nullable: true benefit_At_Member: maxLength: 1 minLength: 1 type: string description: Indicates that the Group offers Member-level benfits. This means that the insured and dependents can enroll in separate coverage. billing_Basis: maxLength: 1 type: string description: No longer in use. nullable: true billing_Cycle_ID: maxLength: 2 type: string description: No longer in use. nullable: true comm_Pct_Flag: type: boolean description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' comm_Per: maxLength: 1 type: string description: No longer in use. nullable: true commission: type: number description: No longer in use. format: double nullable: true coverage_End: type: string description: Date when the contract expires/expired. format: date-time nullable: true cutoff_Age: type: integer description: Identifies the age at which dependents are no longer eligible for coverage. Adult Dependent information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here. format: int32 nullable: true entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true last_Billed: type: string description: No longer in use. format: date-time nullable: true max_At_Subscriber: maxLength: 1 minLength: 1 type: string description: Disability setting for Subscriber-level maximums. orig_Coverage_End: type: string description: No longer in use. format: date-time nullable: true paid_Through: type: string description: Premium Billing setting that holds the premiums paid through for a selection of contracted subscribers. format: date-time nullable: true payor_ID: maxLength: 20 type: string description: No longer in use. nullable: true policy_Number: maxLength: 32 type: string description: No longer in use. nullable: true reinsurer_Id: maxLength: 8 type: string description: No longer in use. nullable: true rider_At_Member: maxLength: 1 minLength: 1 type: string description: Indicates that the Group offers Member-level Riders. salaried_Benefit: type: boolean description: 'For Life & Disability clients, this designates that the subscribers on this contract as having salaried benefit. This impacts how STD and LTD claims are generated during claim creation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' stop_Loss_Amt: type: number description: No longer in use. format: double nullable: true total_At_Member: maxLength: 1 minLength: 1 type: string description: Disability setting for totals calculating at the Member level. update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false GroupContractListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupContract' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupContractPlan: required: - advice_To_Pay - calc_Interest - calc_Interest_ACH - calc_Interest_ACH_On_Adj - calc_Interest_On_Adj - coverage_Start - dependent_Contribution_Pct - division_ID - employee_Contribution_Pct - exempt_Federal - exempt_Medicare - exempt_SocSec - exempt_State - group_ID - plan_ID - prorate_FICA - retirement_Plan - tax_Day_Limit_Type - use_Plan_Options - use_Salary_Pct type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupContract.Group_ID value on the parent record. division_ID: maxLength: 20 minLength: 1 type: string description: References GroupContract.Division_ID value on the parent record. coverage_Start: type: string description: 'References GroupContract.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time plan_ID: maxLength: 20 minLength: 1 type: string description: References Plans.Plan_ID on the parent record. account_Key: type: integer description: Identifies the banking account associated with the selected contract. format: int32 nullable: true advice_To_Pay: type: boolean description: 'When this option is selected, adjudication to mark every claim as ''Advice to Pay'' (ATP). Advice to Pay claims do not produce check records when processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' bpl: maxLength: 16 type: string description: No longer in use. nullable: true billing_Basis: maxLength: 1 type: string description: No longer in use. nullable: true calc_Interest: type: boolean description: 'Indicates if interest is to be calculated for this contract plan during check processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.' calc_Interest_ACH: type: boolean description: 'For ACH payments, Indicates if interest is to be calculated for this contract plan during check processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.' calc_Interest_ACH_Min: type: number description: 'For ACH payments, If interest is to be calculated, this value determines the minimum interest that can be applied. Any interst calculated below this number is ignored.' format: double nullable: true calc_Interest_ACH_Network_Option: maxLength: 16 type: string description: 'For ACH payments, Indicates if interest is to be calculated by: N - In Network or O - Out of Network. Leave this blank if interest applies to both.' nullable: true calc_Interest_ACH_On_Adj: type: boolean description: 'For ACH payments, Flag indicating if interest should be calculated on adjustment claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.' calc_Interest_ACH_Option: maxLength: 16 type: string description: 'For ACH payments, Indicates what field will be used for interest calculation: B - Billed Amount, A - Allowed Amount or P - Paid Amount.' nullable: true calc_Interest_ACH_Pct: type: number description: 'For ACH payments, Indicates the interest percentage to be applied during interest calculations.' format: double nullable: true calc_Interest_ACH_Prompt_Pay_Freq: type: integer description: 'For ACH payments, This is the frequency of "Calc_Interest_Prompt_Pay_Type" for determining if interest is applicable.' format: int32 nullable: true calc_Interest_ACH_Prompt_Pay_Type: maxLength: 1 type: string description: 'For ACH payments, This is the "Calc_Interest_Prompt_Pay_Freq" in number of: D - Days, M - Months or Y - Years.' nullable: true calc_Interest_Min: type: number description: 'If interest is to be calculated, this value determines the minimum interest that can be applied. Any interst calculated below this number is ignored.' format: double nullable: true calc_Interest_Network_Option: maxLength: 16 type: string description: 'Indicates if interest is to be calculated by: N - In Network or O - Out of Network. Leave this blank if interest applies to both.' nullable: true calc_Interest_On_Adj: type: boolean description: 'Flag indicating if interest should be calculated on adjustment claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.' calc_Interest_Option: maxLength: 16 type: string description: 'Indicates what field will be used for interest calculation: B - Billed Amount, A - Allowed Amount or P - Paid Amount.' nullable: true calc_Interest_Pct: type: number description: Indicates the interest percentage to be applied during interest calculations. format: double nullable: true calc_Interest_Prompt_Pay_Freq: type: integer description: This is the frequency of "Calc_Interest_Prompt_Pay_Type" for determining if interest is applicable. format: int32 nullable: true calc_Interest_Prompt_Pay_Type: maxLength: 1 type: string description: 'This is the "Calc_Interest_Prompt_Pay_Freq" in number of: D - Days, M - Months or Y - Years.' nullable: true dependent_Contribution: type: number description: 'For flex, determines the Dependent Contribution amount (or Pct if "Dependent_Contribution_Pct" is flagged)' format: double nullable: true dependent_Contribution_Pct: type: boolean description: 'For flex, notes if the amount entered into "Dependent_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' disability_Pay_Through_Day: type: integer description: This is the day number of the week that disability claims created through the disability advisor will run through. This allows a disability claim with an ETD that ends in the middle of a week to be pushed through the end of that week if needed. format: int32 nullable: true employee_Contribution: type: number description: 'For flex, determines the Employee Contribution amount (or Pct if "Employee_Contribution_Pct" is flagged)' format: double nullable: true employee_Contribution_Pct: type: boolean description: 'For flex, notes if the amount entered into "Employee_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' end_Coverage_Age: type: integer description: This is the age of the subscribers on the day based on "End_Coverage_Age_Type" before benefits are no longer eligible. format: int32 nullable: true end_Coverage_Age_Type: maxLength: 16 type: string description: 'The type of age in years entered in "End_Coverage_Age" by type: EXACTDATE - Age Exact Date, BEGINMONTH - Age at Beginning of month, ENDMONTH - Age at End of month, BEGINYEAR - Age at the beginning of the year, or ENDYEAR - Age at the End of the year.' nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exempt_Federal: type: boolean description: 'Indicates a federal exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.' exempt_Medicare: type: boolean description: 'indicates a medicare exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.' exempt_SocSec: type: boolean description: 'Indicates a social security exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.' exempt_State: type: boolean description: 'Indicates a state exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.' federal_Tax_Day_Limit: type: integer description: Limit of days for the federal tax exemption. format: int32 nullable: true federal_Wage_Limit: type: number description: Wage limit for the federal tax exemption. format: double nullable: true locator: maxLength: 16 type: string description: No longer in use. nullable: true medicare_Tax_Day_Limit: type: integer description: Limit of days for the medicare tax exemption. format: int32 nullable: true medicare_Wage_Limit: type: number description: Wage liimit for the medicare tax exemption. format: double nullable: true minimum_Benefit: type: number description: 'For disability claims, this indicates the minimum benefit (weekly for STD plans or monthly for LTD plans).' format: double nullable: true paid_Through: type: string description: Premium Billing setting that holds the premiums paid through for a selection of contracted subscribers. format: date-time nullable: true payor_ID: maxLength: 20 type: string description: References PayorAccount.Payor_ID value on parent record. nullable: true prorate_FICA: type: boolean description: 'Notes if Disability Claims should Prorate the FICA tax based on the disability payment duration. Note: This field is marked as NOT NULL in the database and therefore required by the API.' rX_BIN: maxLength: 64 type: string description: Information fields used to hold RX information on this Contract Plan for reporting and interfaces. nullable: true rX_CS_Contact: maxLength: 128 type: string description: Information fields used to hold RX information on this Contract Plan for reporting and interfaces. nullable: true rX_CS_Phone: maxLength: 32 type: string description: Information fields used to hold RX information on this Contract Plan for reporting and interfaces. nullable: true rX_GRP: maxLength: 64 type: string description: Information fields used to hold RX information on this Contract Plan for reporting and interfaces. nullable: true rX_Name: maxLength: 512 type: string description: Information fields used to hold RX information on this Contract Plan for reporting and interfaces. nullable: true rX_PCN: maxLength: 64 type: string description: Information fields used to hold RX information on this Contract Plan for reporting and interfaces. nullable: true retirement_Plan: type: boolean description: 'Flag to indicate if this plan on this contract is a retirement plan. This is information only. Note: This field is marked as NOT NULL in the database and therefore required by the API.' salary_Pct: type: number description: 'If "Use_Salary_Pct" option is enabled, this indicatres the percent of salary.' format: double nullable: true socSec_Tax_Day_Limit: type: integer description: Limit of days for the social security tax exemption. format: int32 nullable: true socSec_Wage_Limit: type: number description: Wage limite for Social Security tax exemption. format: double nullable: true state_Tax_Day_Limit: type: integer description: Limit of days for the state tax exemption. format: int32 nullable: true state_Wage_Limit: type: number description: Wage limit for the state tax exemption. format: double nullable: true tax_Day_Limit_Type: type: integer description: 'Indicates if the tax day limitations are by day or calendar months. The database default for this field is ''1''. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true use_Plan_Options: type: boolean description: 'Used on the front end to indicate if the plan options should be shown to the user, has not backend functional impact. Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Salary_Pct: type: boolean description: 'Indicates that disability should be based upon salary percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.' volume: type: number description: No longer in use. format: double nullable: true volume_Max: type: number description: Indicates the benefit maximum of the disabiltiy plan. format: double nullable: true volume_Min: type: number description: Indicates the benefit minimum of the disability plan. format: double nullable: true additionalProperties: false GroupContractPlanListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupContractPlan' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupContractPlanPremium: required: - adult - billing_Basis - child - coverage_Start - division_ID - group_ID - groupContractPlanPremium_Key - plan_ID type: object properties: groupContractPlanPremium_Key: type: integer description: 'No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 adult: type: boolean description: 'No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.' age_From: type: integer description: No longer in use. Replaced by Premium Billing module. format: int32 nullable: true age_Thru: type: integer description: No longer in use. Replaced by Premium Billing module. format: int32 nullable: true applies_To: maxLength: 8 type: string description: No longer in use. Replaced by Premium Billing module. nullable: true billing_Basis: maxLength: 1 minLength: 1 type: string description: No longer in use. Replaced by Premium Billing module. child: type: boolean description: 'No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.' coverage_Start: type: string description: 'No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time division_ID: maxLength: 20 minLength: 1 type: string description: No longer in use. Replaced by Premium Billing module. entry_Date: type: string description: No longer in use. Replaced by Premium Billing module. format: date-time entry_User: maxLength: 20 type: string description: No longer in use. Replaced by Premium Billing module. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: No longer in use. Replaced by Premium Billing module. maximum: type: number description: No longer in use. Replaced by Premium Billing module. format: double nullable: true plan_ID: maxLength: 20 minLength: 1 type: string description: No longer in use. Replaced by Premium Billing module. premium: type: number description: No longer in use. Replaced by Premium Billing module. format: double nullable: true sex: maxLength: 1 type: string description: No longer in use. Replaced by Premium Billing module. nullable: true tier: maxLength: 2 type: string description: No longer in use. Replaced by Premium Billing module. nullable: true update_Date: type: string description: No longer in use. Replaced by Premium Billing module. format: date-time update_User: maxLength: 20 type: string description: No longer in use. Replaced by Premium Billing module. nullable: true additionalProperties: false GroupContractPlanPremiumListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupContractPlanPremium' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupContractPlanPremiumVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupContractPlanPremium' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupContractPlanRider: required: - benefit_Code - coverage_Start - division_ID - employee_Contribution_Pct - group_ID - plan_ID - use_Salary_Pct type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupContractPlan.Group_ID value on the parent record. division_ID: maxLength: 20 minLength: 1 type: string description: References GroupContractPlan.Division_ID value on the parent record. coverage_Start: type: string description: 'References GroupContractPlan.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time plan_ID: maxLength: 20 minLength: 1 type: string description: References GroupContractPlan.Plan_ID value on the parent record. benefit_Code: maxLength: 10 minLength: 1 type: string description: This is the rider being offered for this plan on this contract. The rider is pulled from the list of PlanBenefits with a Rider value = 1. combined_Volume_Max: type: number description: For disability claims this will work with the individual volume max for each payment and set a total max for all payments. The rest are not covered. format: double nullable: true employee_Contribution: type: number description: 'For flex, determines the Employee Contribution amount (or Pct if "Employee_Contribution_Pct" is flagged)' format: double nullable: true employee_Contribution_Pct: type: boolean description: 'For flex, notes if the amount entered into "Employee_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true funding_Indicator: maxLength: 1 type: string description: 'Information only, used in custom client reporting.' nullable: true minimum_Benefit: type: number description: This is the minimum benefit assigned to each disability payment in all benefit calculations (working with volume minimum). format: double nullable: true premium: type: number description: No longer in use. format: double nullable: true salary_Pct: type: number description: 'If "Use_Salary_Pct" is selected, this is the percentage.' format: double nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true use_Salary_Pct: type: boolean description: 'Indicates if a percent of salary should be used when determing this benefit amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' volume: type: number description: 'For disability enrollment, this shows the weekly (for STD) or monthly (for LTD) benefit amount.' format: double nullable: true volume_Max: type: number description: 'When using a salary based benefit, this indicates the max volume (benefit amount) for that calculation.' format: double nullable: true volume_Min: type: number description: 'When using a salary based benefit, this indicates the minimum volume (benefit amount) for that calculation.' format: double nullable: true additionalProperties: false GroupContractPlanRiderExternalID: required: - benefit_Code - coverage_Start - division_ID - external_ID - group_ID - plan_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupContractPlanRider.Group_ID value on the parent record. division_ID: maxLength: 20 minLength: 1 type: string description: References GroupContractPlanRider.Division_ID value on the parent record. coverage_Start: type: string description: 'References GroupContractPlanRider.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time plan_ID: maxLength: 20 minLength: 1 type: string description: References GroupContractPlanRider.Plan_ID value on the parent record. benefit_Code: maxLength: 10 minLength: 1 type: string description: References GroupContractPlanRider.Benefit_Code value on the parent record. external_ID: maxLength: 32 minLength: 1 type: string description: The external ID used for custom tax reporting integrations. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupContractPlanRiderExternalIDListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupContractPlanRiderExternalID' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupContractPlanRiderExternalIDVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupContractPlanRiderExternalID' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupContractPlanRiderListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupContractPlanRider' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupContractPlanRiderVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupContractPlanRider' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupContractPlanVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupContractPlan' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupContractTier: required: - coverage_Start - division_ID - group_ID - tier type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupContract.Group_ID value on the parent record. division_ID: maxLength: 20 minLength: 1 type: string description: References GroupContract.Division_ID value on the parent record. coverage_Start: type: string description: 'References GroupContract.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time tier: maxLength: 2 minLength: 1 type: string description: The tier being offered during this contract. References Tiers.Tier value in referenced table. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupContractTierListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupContractTier' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupContractTierVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupContractTier' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupContractVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupContract' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupCriteria: type: object properties: group_ID: type: string nullable: true division_ID: type: string nullable: true additionalProperties: false GroupDivision: required: - auth_Not_Reqd_Override - cobrA_Division - coE_Network - division_ID - duplicate_Claim_Override - exempt_Federal - exempt_Medicare - exempt_SocSec - exempt_State - ficA_Employer_Match - generate_W2 - group_ID - mail_To_Default - prorate_Deduction - set_Paid_Through - tax_Day_Limit_Type - use_Restricted_Deductions type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References Groups.Group_ID value on parent record. division_ID: maxLength: 20 minLength: 1 type: string description: Unique Division identifier assigned inside this Group. This ID must be unique within the Group ID. acH_Account_Key: type: integer description: References the FundingAccount.Account_Key that holds the ACH information for this Division for any ACH processing. format: int32 nullable: true account_Key: type: integer description: References the PayorAccount.Account_Key value in parent table. format: int32 nullable: true address: maxLength: 255 type: string description: Address associated with the Division. nullable: true address2: maxLength: 128 type: string description: Address 2 associated with the Division. nullable: true adult_Age: type: integer description: Identifies the age at which dependents are considered to be adults. Student status information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here. format: int32 nullable: true agri_Tax_Return: maxLength: 3 type: string description: Information field for custom client reporting. nullable: true auth_Not_Reqd_Override: type: boolean description: 'This flag tells adjudication to not error if no authorization is found on claims that require authorization. Note: This field is marked as NOT NULL in the database and therefore required by the API.' brokerage: maxLength: 256 type: string description: Information field for custom client reporting. nullable: true cobrA_Auto_Term_Adj_Reason: type: integer description: 'When utilizing the Auto-Term process, notes the adjustment reason applied to premiums impacted by a retro term.' format: int32 nullable: true cobrA_Auto_Term_Reason: type: integer description: 'When utilizing the Auto-Term process, indicates the Term Reason to apply if COBRA is being enrolled.' format: int32 nullable: true cobrA_Division: type: boolean description: 'Points to the Division ID that is the COBRA Division for this Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.' coE_Network: type: boolean description: 'Information field for custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.' caseRate: type: number description: Information field for custom client reporting. format: double nullable: true city: maxLength: 25 type: string description: City of the Division address. nullable: true claim_Days_Allowed: type: integer description: No longer in use. format: int32 nullable: true class_Description: maxLength: 128 type: string description: 'No longer in use, replaced by GroupClass table.' nullable: true class_ID: maxLength: 20 type: string description: 'No longer in use, replaced by GroupClass table.' nullable: true contact_Country_Code: maxLength: 8 type: string description: Country Code for the Contact Phone Number. nullable: true contact_Email_Address: maxLength: 128 type: string description: The division contact email address. nullable: true contact_Extension: maxLength: 6 type: string description: The contacts extension for their phone number. nullable: true contact_Phone: maxLength: 20 type: string description: The Contact Phone number for this Divisions Contact. nullable: true contact_Title: maxLength: 20 type: string description: Title of the Division's primary contact. nullable: true country_ID: maxLength: 8 type: string description: Country ID associated with the Division. nullable: true county_Code: maxLength: 8 type: string description: County code of the Division address. nullable: true cutoff_Age: type: integer description: Identifies the age at which dependents are no longer eligible for coverage. Adult Dependent information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here. format: int32 nullable: true default_COBRA_Reason: type: integer description: 'When disenrolling a member and reenrolling into COBRA, this indicates the default reason attached to the disenroll.' format: int32 nullable: true default_Invoice_ReportDefinition_Key: type: integer description: 'For reports in the "INV" Report_Category, this provides the user with the list of invoice reports they can set as the default report using for automated invoice generation.' format: int32 nullable: true disability_Pay_Through_Day: type: integer description: Indicates the day of the week the paid through is set when using automatic paid through dates. format: int32 nullable: true disenroll_Date: type: string description: This notes that the Division has been terminated and what date. An active Division has a NULL value here. format: date-time nullable: true distribution_Account_Key: type: integer description: References the PayorAccount.Account_Key value in parent table. format: int32 nullable: true distribution_Payor_ID: maxLength: 20 type: string description: References the PayorAccount.Payor_ID value in parent table. nullable: true duplicate_Claim_Override: type: boolean description: 'This flag tells adjudication to ignore Duplicate Claims Processing logic if enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exempt_Federal: type: boolean description: 'For Disability tax calculations, this indicates if the Division is exempt from taking Federal taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.' exempt_Medicare: type: boolean description: 'For Disability tax calculations, this indicates if the Division is exempt from taking Medicare taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.' exempt_SocSec: type: boolean description: 'For Disability tax calculations, this indicates if the Division is exempt from taking Social Security taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.' exempt_State: type: boolean description: 'For Disability tax calculations, this indicates if the Division is exempt from taking State taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ficA_Employer_Match: type: boolean description: 'Notes if the employer matches FICA (lowers that tax to 0) during claims adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.' fax: maxLength: 20 type: string description: The fax number for this Division. nullable: true fax_Country_Code: maxLength: 8 type: string description: Country Code for the Division Fax Number. nullable: true federal_ID: maxLength: 20 type: string description: This Division Tax ID. nullable: true federal_Tax_Day_Limit: type: integer description: Limit of days for the federal tax exemption. format: int32 nullable: true federal_Wage_Limit: type: number description: Wage limit for the federal tax exemption. format: double nullable: true generate_W2: type: boolean description: 'Notes if this Division is part of tax reporting and should have its data sent for W2 generation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' groupDivisionCaptive: maxLength: 256 type: string description: Information field for custom client reporting. nullable: true invoice_Grace_Period: type: integer description: Indicates the grace period for invoice generation for this Division. This value works with "Invoice_Grace_Period_Type" to determine duration. format: int32 nullable: true invoice_Grace_Period_Ex_Code: maxLength: 6 type: string description: 'When a grace period is applied to an invoice that impacts "Paid Through", the affected claims will apply this Ex Code.' nullable: true invoice_Grace_Period_Type: maxLength: 16 type: string description: 'Based on "Invoice_Grace_Period", this is the Days, Weeks, Months or Years that grace period extends.' nullable: true invoice_Level: maxLength: 1 type: string description: 'Indiciates the level of invoicing done by premium billing. There are 3 levels you can configure: S - Subscriber level invoicing (meaning an invoice per enrolled Subscriber), D - Division level invoicing (meaning an invoice per Division with all enrolled Subscribers in that Division on that Invoice), and G - Group level invoicing (meaning an invoice for the whole group with all enrolled Subscribers on the same invoice).' nullable: true invoice_Remit_Address1: maxLength: 128 type: string description: 'When generating Division level invoices through premium biling, this is the Address on that invoice.' nullable: true invoice_Remit_Address2: maxLength: 128 type: string description: 'When generating Division level invoices through premium biling, this is the Address 2 on that invoice.' nullable: true invoice_Remit_City: maxLength: 32 type: string description: 'When generating Division level invoices through premium biling, this is the City on that invoice.' nullable: true invoice_Remit_Country_Code: maxLength: 8 type: string description: 'When generating Division level invoices through premium biling, this is the Phone Number Country Code on that invoice.' nullable: true invoice_Remit_Country_ID: maxLength: 8 type: string description: 'When generating Division level invoices through premium biling, this is the Country ID on that invoice.' nullable: true invoice_Remit_Name: maxLength: 128 type: string description: 'When generating Division level invoices through premium biling, this is the Name on that invoice.' nullable: true invoice_Remit_Phone_Number: maxLength: 32 type: string description: 'When generating Division level invoices through premium biling, this is the Phone Number on that invoice.' nullable: true invoice_Remit_State: maxLength: 2 type: string description: 'When generating Division level invoices through premium biling, this is the State on that invoice.' nullable: true invoice_Remit_Zip_Code: maxLength: 32 type: string description: 'When generating Division level invoices through premium biling, this is the Zip Code on that invoice.' nullable: true issue_State: maxLength: 2 type: string description: 'For Life & Disability clients, this holds the issue state for processing taxes and reporting.' nullable: true mail_To_Default: type: boolean description: 'For Life & Disability clients, this is the default Mail To setting applied to claims created through the advisor wizards. Note: This field is marked as NOT NULL in the database and therefore required by the API.' medicare_Tax_Day_Limit: type: integer description: Limit of days for the medicare tax exemption. format: int32 nullable: true medicare_Wage_Limit: type: number description: Wage liimit for the medicare tax exemption. format: double nullable: true name: maxLength: 50 type: string description: Name of the Group Division. nullable: true notes: type: string description: No longer in use. Replaced by the Notes module. nullable: true numberLives: type: integer description: Information field for custom client reporting. format: int32 nullable: true original_Date: type: string description: This is the first start date (original effective date) of the Division inside this group. This date should be equal to or earlier than the first GroupContact.Coverage_Start date attached to this Division. format: date-time nullable: true other_Insurance_ExCode: maxLength: 6 type: string description: This is the Ex Code applied if COB is identified during adjudciation and Other Insurance information is used during processing. nullable: true paid_Through: type: string description: This is the paid through date for any Division level invoices through premium billing. This can be manually set or updated by the system. format: date-time nullable: true participationIncentive_ID: maxLength: 32 type: string description: Information field for custom client reporting. nullable: true pay_To_Account: type: integer description: 'For processing that uses the Pay To Account, this referneces the FundingAccount.Account_Key for that process.' format: int32 nullable: true payor_ID: maxLength: 20 type: string description: References the PayorAccount.Payor_ID value in parent table. nullable: true pend_Ex_Code: maxLength: 6 type: string description: The Ex Code applied during claims adjudication if "Pend_Flag" is enabled. nullable: true pend_Flag: maxLength: 1 type: string description: Notes that this Division should have a pend code (Ex Code) applied during claims processing for any claims for this Division. nullable: true phone: maxLength: 20 type: string description: The phone number for this Division. nullable: true phone_Country_Code: maxLength: 8 type: string description: Country Code for the Division Phone Number. nullable: true premium_Location: maxLength: 50 type: string description: No longer in use. nullable: true primary_Contact: maxLength: 25 type: string description: Primary contact of the Division. nullable: true prorate_Deduction: type: boolean description: 'Notes if this division should have disability deductions pro-rated during claims processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.' prorate_Deduction_Type: maxLength: 10 type: string description: 'Indicates the type of prorating to calculate against. If calculating against flat deduction types only, set to F, to apply prorating to Percentage based deductions, set to P, if applying prorating on all deduction types, set to B.' nullable: true reference_Based_Pricing: maxLength: 1 type: string description: Information field for custom client reporting. nullable: true region_Code: maxLength: 32 type: string description: Information field for noting the region for this Division. nullable: true reinsurance_Option: maxLength: 256 type: string description: No longer in use. Replaces by the full reinsurance module. nullable: true seerData: type: integer description: Information field for custom client reporting. format: int32 nullable: true set_Paid_Through: type: boolean description: 'Notes if this division should have the paid through set as part of satisfying a premium bill. Note: This field is marked as NOT NULL in the database and therefore required by the API.' socSec_Tax_Day_Limit: type: integer description: Limit of days for the social security tax exemption. format: int32 nullable: true socSec_Wage_Limit: type: number description: Wage limite for Social Security tax exemption. format: double nullable: true spec_Deductible: maxLength: 256 type: string description: No longer in use. Replaces by the full reinsurance module. nullable: true state: maxLength: 2 type: string description: State of the Division address. nullable: true state_Tax_Day_Limit: type: integer description: Limit of days for the state tax exemption. format: int32 nullable: true state_Wage_Limit: type: number description: Wage limit for the state tax exemption. format: double nullable: true tax_Day_Limit_Type: type: integer description: 'Indicates if the tax day limitations are by day or calendar months. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 transplantElite: maxLength: 256 type: string description: Information field for custom client reporting. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true use_Restricted_Deductions: type: boolean description: 'Limits the deduction types that can be selected on disability claims to use the GroupDivisionDeductionType list. Note: This field is marked as NOT NULL in the database and therefore required by the API.' zip_Code: maxLength: 32 type: string description: The Zip Code for this Division address. nullable: true additionalProperties: false GroupDivisionCaptive: required: - groupDivisionCaptive1 type: object properties: groupDivisionCaptive1: maxLength: 256 minLength: 1 type: string description: Unique identifier for this Captive. description: maxLength: 512 type: string description: The description for this captive to be used on the Division. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupDivisionCaptiveListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupDivisionCaptive' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupDivisionCaptiveVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupDivisionCaptive' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupDivisionCobra: required: - cobra_Division_ID - division_ID - group_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupDivision.Group_ID value on the parent record. division_ID: maxLength: 20 minLength: 1 type: string description: References GroupDivision.Division_ID value on the parent record. cobra_Division_ID: maxLength: 20 minLength: 1 type: string description: Which Division ID inside this Group that is the COBRA Division. additionalProperties: false GroupDivisionCobraListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupDivisionCobra' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupDivisionCobraVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupDivisionCobra' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupDivisionDeductionType: required: - deduction_Type - division_ID - group_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupDivision.Group_ID value on the parent record. division_ID: maxLength: 20 minLength: 1 type: string description: References GroupDivision.Division_ID value on the parent record. deduction_Type: maxLength: 8 minLength: 1 type: string description: References ClaimDeductionType.Deduction_Type for the list of deduction types that can be used during disability processing. This filters the list during seleciton based on what Division the member is enrolled. additionalProperties: false GroupDivisionDeductionTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupDivisionDeductionType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupDivisionDeductionTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupDivisionDeductionType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupDivisionIDCode: required: - division_ID - group_ID - iD_Code type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: No longer in use. Replaced by IDCodeValue table. division_ID: maxLength: 20 minLength: 1 type: string description: No longer in use. Replaced by IDCodeValue table. iD_Code: maxLength: 6 minLength: 1 type: string description: No longer in use. Replaced by IDCodeValue table. description: maxLength: 64 type: string description: No longer in use. Replaced by IDCodeValue table. nullable: true entry_Date: type: string description: No longer in use. Replaced by IDCodeValue table. format: date-time entry_User: maxLength: 20 type: string description: No longer in use. Replaced by IDCodeValue table. nullable: true update_Date: type: string description: No longer in use. Replaced by IDCodeValue table. format: date-time update_User: maxLength: 20 type: string description: No longer in use. Replaced by IDCodeValue table. nullable: true additionalProperties: false GroupDivisionIDCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupDivisionIDCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupDivisionIDCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupDivisionIDCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupDivisionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupDivision' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupDivisionVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupDivision' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupExCodeCriteria: required: - groupExCodeCriteria_Key type: object properties: groupExCodeCriteria_Key: type: integer description: Unique identifier for each Ex Code criteria for this Group/Division. format: int32 criteria_From: maxLength: 64 type: string description: The from value for this criteria. nullable: true criteria_Operator: maxLength: 1 type: string description: The operator for this part of the criteria. nullable: true criteria_Thru: maxLength: 64 type: string description: The thru value for this criteria. nullable: true division_ID: maxLength: 20 type: string description: References GroupDivision.Division_ID value on the parent record. nullable: true eX_Code: maxLength: 6 type: string description: The Ex Code that should be applied when this criteria is met during adjudication. nullable: true groupExCodeCriteriaColumn_Key: type: integer description: 'Indicates the column to interrogate during adjudication: 1 - Modifier, 2 - Federal ID or 3 - Total Payable.' format: int32 nullable: true group_ID: maxLength: 20 type: string description: References GroupDivision.Group_ID value on the parent record. nullable: true additionalProperties: false GroupExCodeCriteriaListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupExCodeCriteria' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupExCodeCriteriaVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupExCodeCriteria' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupFlex: required: - calendar_Year - contribution_Pct - effective_Date - group_ID - plan_ID - term_Date type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References Groups.Group_ID value on the parent record. plan_ID: maxLength: 20 minLength: 1 type: string description: References the Plans.Plan_ID on the parent record. Must be a plan with a plan type flagged as Flex. calendar_Year: maxLength: 4 minLength: 1 type: string description: 'The numeric calendar year for this flex period. For example, 2022.' contribution_Amount: type: number description: This is the employer contribution amount. format: double nullable: true contribution_Pct: type: boolean description: 'Indicates if the amount entered in "Contribution_Amount" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' contribution_Pct_Type: maxLength: 16 type: string description: 'When "Contribution_Pct" is used, this notes what the contribution percentage is based upon: EMPELE - % of Employee Contribution, SALNET - % of Employee Net Salary, SALGROSS - % of Employee Gross Salary.' nullable: true contribution_Schedule: maxLength: 32 type: string description: References ContributionSchedule.Contribution_Schedule to define the employer contribution schedule for this flex offering. nullable: true effective_Date: type: string description: 'The effective date for this flex period. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true first_Contribution_Date: type: string description: Notes the date that is the start date that employer contribution schedule will build upon to lay out the contributions for the flex period. format: date-time nullable: true first_Payment_Date: type: string description: Notes the date that is the start date that payment schedule will build upon to lay out the payment for the flex period. format: date-time nullable: true first_Reimburse_Date: type: string description: Notes the date that is the start date that reimbursement schedule will build upon to lay out the reimbursments for the flex period. format: date-time nullable: true flex_Vendor: maxLength: 32 type: string description: 'For EDI processing and integrations, notes the external flex vendor used for procesisng (typically card swipes).' nullable: true grace_Period: type: integer description: The grace period value based on "Grace_Period_Type" for how long you have to process a flex claim after the term date. format: int32 nullable: true grace_Period_Type: maxLength: 16 type: string description: 'Combined with "Grace_Period", notes the grace period in: D - Days or M - Months.' nullable: true max_Election: type: number description: The Max Election a member can enter for this offering. format: double nullable: true minimum_Payment: type: number description: The minimum payment that can be applied during flex claims processing. format: double nullable: true payment_Schedule: maxLength: 32 type: string description: References PaymentSchedule.Payment_Schedule to define the payment schedule for this flex offering. nullable: true reimburse_Schedule: maxLength: 32 type: string description: References ReimburseSchedule.Reimburse_Schedule to define the reimbursement schedule for this flex offering. nullable: true rollover_Amount: type: number description: The amount of flex contribution that can be rolled over to a subsquent flex offering on this same group. format: double nullable: true submit_Period: type: integer description: The submit period value based on "Submit_Period_Type" for how long you have to submit a flex claim after the term date. format: int32 nullable: true submit_Period_Type: maxLength: 16 type: string description: 'Combined with "Submit_Period", notes the submission period in: D - Days or M - Months.' nullable: true term_Date: type: string description: 'The term date for this flex period. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupFlexCreate: required: - co_Ins - co_Pay - combine - deductible - employee_Only - group_ID - groupFlexCreate_Key - not_Covered type: object properties: groupFlexCreate_Key: type: integer description: 'Unique identifier for each auto-create flex setting. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 co_Ins: type: boolean description: 'Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.' co_Pay: type: boolean description: 'Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.' combine: type: boolean description: 'Indicates if the various member responsibility amounts selected for auto flex creation should be combined into a single claim payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.' create_From_Plan_ID: maxLength: 20 type: string description: Indicates the Plan (typically the medical plan) that will have the claim with member responsibility that needs to be moved to a flex submission. nullable: true create_To_Plan_ID: maxLength: 20 type: string description: Indicates the Plan (the Flex plan) that will have the member responsibility moved to in order to create the flex submission. nullable: true deductible: type: boolean description: 'Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.' effective_Date: type: string description: The effective date of this auto-create processing rule. format: date-time nullable: true employee_Only: type: boolean description: 'A flag indicating auto created flex claims should be created for employees only, not members. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: The Ex Code that is applied to the newly created flex claim. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: References Groups.Group_ID value on the parent record. not_Covered: type: boolean description: 'Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.' term_Date: type: string description: The term date for this auto-create processing rule. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupFlexCreateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupFlexCreate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupFlexCreateVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupFlexCreate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupFlexListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupFlex' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupFlexSchedule: required: - calendar_Year - group_ID - groupFlexSchedule_Key - plan_ID - schedule_Date - schedule_Type type: object properties: groupFlexSchedule_Key: type: integer description: 'The unique identifier for the flex schedule. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 calendar_Year: maxLength: 4 minLength: 1 type: string description: References GroupFlex.Calendar_Year value on the parent record. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: References GroupFlex.Group_ID value on the parent record. plan_ID: maxLength: 20 minLength: 1 type: string description: References GroupFlex.Plan_ID value on the parent record. schedule_Date: type: string description: 'The scheduled date of the flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time schedule_Type: maxLength: 16 minLength: 1 type: string description: 'The type of schedule to apply for payments. If this value is CUSTOM, the user defines the value by hand for "Schedule_Date". For all other types the "Schedule_Date" is calculated and populated.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupFlexScheduleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupFlexSchedule' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupFlexScheduleVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupFlexSchedule' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupFlexVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupFlex' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupNetwork: required: - coverage_Start - division_ID - group_ID - networkID - process_As_OON - state type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupContract.Group_ID value on the parent record. division_ID: maxLength: 20 minLength: 1 type: string description: References GroupContract.Division_ID value on the parent record. coverage_Start: type: string description: 'References GroupContract.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time networkID: maxLength: 10 minLength: 1 type: string description: References Networks.Network_ID value on the parent record. state: maxLength: 2 minLength: 1 type: string description: References State.State value on the parent record. apC_Schedule: maxLength: 16 type: string description: Allows the User to attach an APC schedule to be applied as part of the Network. nullable: true claim_Days_Allowed: type: integer description: Idenfities the allows number of claim days for claims within this Network. format: int32 nullable: true drG_Schedule: maxLength: 16 type: string description: Allows the User to attach a DRG schedule to be applied as part of the Network. nullable: true eff_Date: type: string description: Date when the Contract Network stettings become effective. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true network_Type: maxLength: 16 type: string description: 'Identifies the type of the Network: 0 - Primary, 1 - Secondary, 2 - Wrap, 3 - Specialty.' nullable: true priority: type: integer description: Notes the priority of this network within this offering. Impacts which network is selected during network assignment during adjudication. format: int32 nullable: true process_As_OON: type: boolean description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupNetworkAddOn: required: - discount_Payment_Pct - discount_Threshold_Pct - group_ID - groupNetworkAddOn_Key - incurred_From - network_ID type: object properties: groupNetworkAddOn_Key: type: integer description: 'Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Used in custom client processing with no functional impact on existing processing. nullable: true discount_Payment: type: number description: Used in custom client processing with no functional impact on existing processing. format: double nullable: true discount_Payment_Pct: type: boolean description: 'Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.' discount_Threshold: type: number description: Used in custom client processing with no functional impact on existing processing. format: double nullable: true discount_Threshold_Pct: type: boolean description: 'Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: Used in custom client processing with no functional impact on existing processing. incurred_From: type: string description: 'Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time incurred_Thru: type: string description: Used in custom client processing with no functional impact on existing processing. format: date-time nullable: true member_Seq: maxLength: 2 type: string description: Used in custom client processing with no functional impact on existing processing. nullable: true network_ID: maxLength: 20 minLength: 1 type: string description: Used in custom client processing with no functional impact on existing processing. paid_From: type: string description: Used in custom client processing with no functional impact on existing processing. format: date-time nullable: true paid_Thru: type: string description: Used in custom client processing with no functional impact on existing processing. format: date-time nullable: true payment_Limit: type: number description: Used in custom client processing with no functional impact on existing processing. format: double nullable: true payment_Limit_Type: maxLength: 32 type: string description: Used in custom client processing with no functional impact on existing processing. nullable: true provider_ID: maxLength: 20 type: string description: Used in custom client processing with no functional impact on existing processing. nullable: true subscriber_ID: maxLength: 9 type: string description: Used in custom client processing with no functional impact on existing processing. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupNetworkAddOnListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupNetworkAddOn' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupNetworkAddOnVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupNetworkAddOn' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupNetworkCriteria: required: - groupNetworkCriteria_Key type: object properties: groupNetworkCriteria_Key: type: integer description: Unique identifier for each Network Criteria used for network selection during adjudication. format: int32 coverage_Start: type: string description: References GroupNetwork.Coverage_Start value on the parent record. format: date-time nullable: true criteria_From: maxLength: 64 type: string description: The from value applied to this criteria. nullable: true criteria_Operator: maxLength: 1 type: string nullable: true criteria_Thru: maxLength: 64 type: string description: The thru value applied to this criteria. nullable: true division_ID: maxLength: 20 type: string description: References GroupNetwork.Division_ID value on the parent record. nullable: true groupNetworkCriteriaColumn_Key: type: integer description: References GroupNetworkCriteriaColumn.GroupNetworkCriteriaColumn_Key in referenced table. format: int32 nullable: true group_ID: maxLength: 20 type: string description: References GroupNetwork.Group_ID value on the parent record. nullable: true networkID: maxLength: 10 type: string description: References GroupNetwork.Network_ID value on the parent record. nullable: true additionalProperties: false GroupNetworkCriteriaColumn: required: - groupNetworkCriteriaColumn_Key type: object properties: groupNetworkCriteriaColumn_Key: type: integer description: 'Unique identifier for each column that can be selected for network criteria selection (provider zip, subscriber zip, etc.)' format: int32 data_Type: maxLength: 32 type: string description: The datatype of the criteria column used for network criteria. nullable: true description: maxLength: 128 type: string description: Description of the Criteria. nullable: true search_Object: maxLength: 128 type: string description: 'If there is an application object being used for lookup purposes, this would reference that object (developer field).' nullable: true additionalProperties: false GroupNetworkCriteriaColumnListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupNetworkCriteriaColumn' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupNetworkCriteriaColumnVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupNetworkCriteriaColumn' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupNetworkCriteriaListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupNetworkCriteria' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupNetworkCriteriaVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupNetworkCriteria' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupNetworkListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupNetwork' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupNetworkVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupNetwork' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccount: required: - check_Incurred - check_Received - group_ID - setting_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References Groups.Group_ID value on the parent record. setting_ID: maxLength: 32 minLength: 1 type: string description: Unique identifier for each payor/account setting. account_Key: type: integer description: The Account_Key to be assigned on the claim if subsequent criteria values match the claim. format: int32 nullable: true check_Incurred: type: boolean description: 'Indiciates if Service_Date should be interrogated for this setting. If so, use Incurred_From and Incurred_Thru values. Note: This field is marked as NOT NULL in the database and therefore required by the API.' check_Received: type: boolean description: 'Indiciates if Received_Date should be interrogated for this setting. If so, use Received_From and Received_Thru values. Note: This field is marked as NOT NULL in the database and therefore required by the API.' currency_ID: maxLength: 16 type: string description: 'If this payor/account setting should be applied only to specific currency, you would note that currency here.' nullable: true description: maxLength: 512 type: string description: A brief description of this payor/account setting for reporting and admin purposes. nullable: true division_ID: maxLength: 20 type: string description: 'Optionally, set the Division_ID (reference GroupDivision.Division_ID) if this setting is Division level.' nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: 'If an Ex_Code should be placed on the claim when this setting is hit during adjudication, you would assign that Ex_Code here.' nullable: true incurred_From: type: string description: The date range for this setting if Check_Incurred is flagged. format: date-time nullable: true incurred_Thru: type: string description: The date range for this setting if Check_Incurred is flagged. format: date-time nullable: true payor_ID: maxLength: 20 type: string description: The Payor_ID to be assigned on the claim if subsequent criteria values match the claim. nullable: true received_From: type: string description: The date range for this setting if Check_Received is flagged. format: date-time nullable: true received_Thru: type: string description: The date range for this setting if Check_Received is flagged. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupPayorAccountBenefit: required: - benefit_Code - group_ID - setting_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupPayorAccount.Group_ID on the parent record. setting_ID: maxLength: 32 minLength: 1 type: string description: References GroupPayorAccount.Setting_ID on the parent record. benefit_Code: maxLength: 10 minLength: 1 type: string description: 'If the setting is Benefit Code specific, you would include the Benefit Code here.' entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupPayorAccountBenefitListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupPayorAccountBenefit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccountBenefitVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupPayorAccountBenefit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccountListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupPayorAccount' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccountNetwork: required: - group_ID - network_ID - setting_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupPayorAccount.Group_ID on the parent record. setting_ID: maxLength: 32 minLength: 1 type: string description: References GroupPayorAccount.Setting_ID on the parent record. network_ID: maxLength: 10 minLength: 1 type: string description: 'If the setting is Network ID specific, you would include that Network ID here.' additionalProperties: false GroupPayorAccountNetworkListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupPayorAccountNetwork' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccountNetworkVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupPayorAccountNetwork' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccountPayTo: required: - group_ID - send_Check_To - setting_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupPayorAccount.Group_ID on the parent record. setting_ID: maxLength: 32 minLength: 1 type: string description: References GroupPayorAccount.Setting_ID on the parent record. send_Check_To: maxLength: 1 minLength: 1 type: string description: 'If the setting is Pay To specific, you would include that Pay To here.' additionalProperties: false GroupPayorAccountPayToListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupPayorAccountPayTo' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccountPayToVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupPayorAccountPayTo' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccountPlanType: required: - group_ID - plan_Type - setting_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupPayorAccount.Group_ID on the parent record. setting_ID: maxLength: 32 minLength: 1 type: string description: References GroupPayorAccount.Setting_ID on the parent record. plan_Type: maxLength: 6 minLength: 1 type: string description: 'If the setting is Plan Type specific, you would include that Plan Type here.' additionalProperties: false GroupPayorAccountPlanTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupPayorAccountPlanType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccountPlanTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupPayorAccountPlanType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccountProviderFederal: required: - federal_ID - group_ID - setting_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupPayorAccount.Group_ID on the parent record. setting_ID: maxLength: 32 minLength: 1 type: string description: References GroupPayorAccount.Setting_ID on the parent record. federal_ID: maxLength: 20 minLength: 1 type: string description: 'If the setting is Tax ID specific, you would include that Tax ID here.' additionalProperties: false GroupPayorAccountProviderFederalListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupPayorAccountProviderFederal' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccountProviderFederalVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupPayorAccountProviderFederal' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccountSender: required: - group_ID - sender_ID - setting_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupPayorAccount.Group_ID on the parent record. setting_ID: maxLength: 32 minLength: 1 type: string description: References GroupPayorAccount.Setting_ID on the parent record. sender_ID: maxLength: 15 minLength: 1 type: string description: 'If the setting is Sender ID (x12 837) specific, you would include that Sender ID here.' additionalProperties: false GroupPayorAccountSenderListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupPayorAccountSender' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccountSenderVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupPayorAccountSender' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPayorAccountVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupPayorAccount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPlanYear: required: - division_ID - group_ID - plan_Year - qtr4_Accum - qtr4_Deductible - qtr4_Member - qtr4_Out_Of_Pocket - qtr4_Subscriber type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupDivision.Group_ID value on the parent record. division_ID: maxLength: 20 minLength: 1 type: string description: References GroupDivision.Division_ID value on the parent record. plan_Year: maxLength: 8 minLength: 1 type: string description: 'User defined Plan Year value for this accumulator period. Should denote the values in From_Date and Thru_Date. Example: Plan Year "CY2009" would be 1/1/2009 - 12/31/2009.' entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: 'If an Ex_Code should be applied when a claim is identified for carry over, place that here.' nullable: true from_Date: type: string description: The date range for this Plan Year. format: date-time nullable: true plan_Type: maxLength: 6 type: string description: 'If this Plan Year is specific to a Plan Type, you would denote that here. Normally no value is set for standard accumulation.' nullable: true qtr4_Accum: type: boolean description: 'Indicates if this Plan Year has 4th quarter carry-over. Note: This field is marked as NOT NULL in the database and therefore required by the API.' qtr4_Benefit_Code: maxLength: 10 type: string description: When accumulators are carried over they are bucketed into a single Benefit Code (typically a shell Benefit Code to catch the carry-over dollars). nullable: true qtr4_Deductible: type: boolean description: 'Indicates if carry-over applies to Deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.' qtr4_From_Date: type: string description: 'If this Plan Year has 4th quarter carrry-over, this would indiate the dates, inside From_Date and Thru_Date, that signify the 4th quarter carry-over period.' format: date-time nullable: true qtr4_Member: type: boolean description: 'Indicates if the carry-over applies to Member level accumulators. Note: This field is marked as NOT NULL in the database and therefore required by the API.' qtr4_Out_Of_Pocket: type: boolean description: 'Indicates if carry-over applies to Out of Pocket. Note: This field is marked as NOT NULL in the database and therefore required by the API.' qtr4_Out_Of_Pocket_Type: maxLength: 16 type: string description: 'If Out of Pocket carry-over is flagged, this identifies what constitutes Out of Pocket (Deductible, Co-Ins, Co-Pay).' nullable: true qtr4_PlanYear: maxLength: 8 type: string description: Indicates which Plan Year these carry-over accumulators will carry over to (typically a plan year on the other side of the carry-over period). nullable: true qtr4_Subscriber: type: boolean description: 'Indicates if the carry-over applies to the entire Family for accumulators. Note: This field is marked as NOT NULL in the database and therefore required by the API.' qtr4_Thru_Date: type: string description: 'If this Plan Year has 4th quarter carrry-over, this would indiate the dates, inside From_Date and Thru_Date, that signify the 4th quarter carry-over period.' format: date-time nullable: true thru_Date: type: string description: The date range for this Plan Year. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupPlanYearAutoPriorAccum: required: - division_ID - group_ID - groupPlanYearAutoPriorAccum_Key - plan_Type - plan_Year - prior_Accum_Plan_Type type: object properties: groupPlanYearAutoPriorAccum_Key: type: integer description: 'Unique identifer for each auto prior accum configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 division_ID: maxLength: 20 minLength: 1 type: string description: References GroupPlanYear.Division_ID value on the parent record. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: References GroupPlanYear.Group_ID value on the parent record. plan_Type: maxLength: 6 minLength: 1 type: string description: References GroupPlanYear.Plan_Type value on the parent record. plan_Year: maxLength: 20 minLength: 1 type: string description: References GroupPlanYear.Plan_Year value on the parent record. prior_Accum_Benefit_Code: maxLength: 10 type: string description: 'When auto prior accums are set, this indicates the Benefit_Code value to be written to the prior accum record.' nullable: true prior_Accum_Plan_Type: maxLength: 6 minLength: 1 type: string description: 'When auto prior accums are set, this indicates the Plan_Type value to be written to the prior accum record.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupPlanYearAutoPriorAccumListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccum' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPlanYearAutoPriorAccumVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupPlanYearAutoPriorAccum' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPlanYearListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupPlanYear' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPlanYearVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupPlanYear' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPremRateCategory: required: - group_ID - premRate_Category - reportDefinition_Key - sequence type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References Groups.Group_ID value on the parent record. reportDefinition_Key: type: integer description: References ReportDefinition.ReportDefinition_Key on the referenced record. This is the report (of Report_Category "INV") that will have a dynamic sequence of premrate categories. format: int32 premRate_Category: maxLength: 32 minLength: 1 type: string description: References PremRateCategory.PremRate_Category on the referenced record. This si the category that will be sequenced on a "INV" report. sequence: type: integer description: The suquence of this Category on the "INV" report. format: int32 additionalProperties: false GroupPremRateCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupPremRateCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPremRateCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupPremRateCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPriceAdjust: required: - effective_Date - group_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: Used in custom client processing with no functional impact on existing processing. effective_Date: type: string description: 'Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true price_Adjust: type: number description: Used in custom client processing with no functional impact on existing processing. format: double nullable: true term_Date: type: string description: Used in custom client processing with no functional impact on existing processing. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupPriceAdjustListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupPriceAdjust' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupPriceAdjustVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupPriceAdjust' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupSelfAdmin: required: - active - group_ID - groupSelfAdmin_Key - use_Volume_Scale type: object properties: groupSelfAdmin_Key: type: integer description: 'Unique identifier for each Self Admin configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 active: type: boolean description: 'Notes if this coniguration is active for calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' age: type: integer description: The age for this invoice calculation. format: int32 nullable: true benefit_Code: maxLength: 10 type: string description: 'If there is Benefit level configuration, you would apply that here. If blank, this configuration applies to all benefits inside the group.' nullable: true dependents: type: integer description: The dependent count for this invoice calculation. format: int32 nullable: true division_ID: maxLength: 20 type: string description: 'If there is Division level configuration, you would apply that here. If blank, this confiruation applies to the entire group.' nullable: true entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: References Groups.Group_ID values on parent record. invoice_Level: maxLength: 1 type: string description: Notes the invoice level for self-admin invoicing. Works smilar to GroupDivision setting in that it combines other self-admin confiration to the common level. nullable: true members: type: integer description: The member count for this invoice calculation. format: int32 nullable: true plan_ID: maxLength: 20 type: string description: 'If there is Plan level configuration, you would apply that here. If blank, this configuration applies to all plans inside the group.' nullable: true sex: maxLength: 1 type: string description: The gender for this invoice calculation. nullable: true subscribers: type: integer description: The subscriber count for this invoice calculation. format: int32 nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true use_Volume_Scale: type: boolean description: 'Indicates if volume scale determines the volume for this invoice calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' volume: type: number description: The volume for this invoice calculation. format: double nullable: true additionalProperties: false GroupSelfAdminListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupSelfAdmin' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupSelfAdminVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupSelfAdmin' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupStudentAge: required: - groupStudentAge_Key type: object properties: groupStudentAge_Key: type: integer description: 'Unique identifer for each Student/Age configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 age_From: type: integer description: Indicates the starting age of the acceptable student age range. format: int32 nullable: true age_Thru: type: integer description: Indicates the ending age of the acceptable student age range. format: int32 nullable: true age_Type: maxLength: 16 type: string description: 'Indicates the exact date when the age range applies: Birth Date - student age settings become effective/expire as of the birth date during the year in which they reach the chosen age. End of Birth Month - student age settings become effective/expired as of the end of the birth moth during the year in which they reach the chosen age. End of Birth Year - student age settings become effective/expired as of the end of the birth year in which they reach the chosen age.' nullable: true division_ID: maxLength: 20 type: string description: References the GroupDivision.Division_ID value on the parent record. nullable: true effective_Date: type: string description: Date when the student age setting becomes/became effective. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: Ex code that will be applied to claims of students from the Group who fall within the designated criteria. nullable: true group_ID: maxLength: 20 type: string description: References the GroupDivision.Group_ID value on the parent record. nullable: true state: maxLength: 2 type: string description: Identifies the state in which the student age settings apply. nullable: true state_Type: maxLength: 16 type: string description: 'Indicates if the state used in this settings is the member, subscriber or employer state.' nullable: true term_Date: type: string description: Date when the student age setting expires/expired. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupStudentAgeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupStudentAge' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupStudentAgeVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupStudentAge' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupUCPercent: required: - claim_Type - group_ID - groupUCPercent_Key - use_Custom_Percent type: object properties: groupUCPercent_Key: type: integer description: 'Unique identifier for each UC Percent configuration for this Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 claim_Type: maxLength: 20 minLength: 1 type: string description: Claim type that the UC percent settings will be applied to. custom_Percent: type: number description: Identifies the custom percentage that will be applied by the UC percent settings. format: double nullable: true custom_Percent_Claim_Type: maxLength: 20 type: string description: 'When using a custom percent, this applies a claim type restriction to the rule limiting which claim types can have UC applied.' nullable: true effective_Date: type: string description: Date when the UC percent settings become/became effective. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true fee_Sched: maxLength: 8 type: string description: When a fee schedule is used as the rate structure than the UC tables. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: References the Groups.Group_ID value on the parent record. term_Date: type: string description: Date when the UC percent settings expire/expired. format: date-time nullable: true uC_Percent: maxLength: 8 type: string description: Allows the User to select a default percentage that will be applied by the UC percent settings. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true use_Custom_Percent: type: boolean description: 'Allows the User to build a custom percentage for the UC percent settings instead of using one of the default percentages. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false GroupUCPercentClaimType: required: - uC_Percent_Claim_Type type: object properties: uC_Percent_Claim_Type: maxLength: 20 minLength: 1 type: string description: 'When using UC, this is the UC Claim Type used to pull rate values.' description: maxLength: 128 type: string description: A user friendly description of the UC configuration being created. nullable: true entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false GroupUCPercentClaimTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupUCPercentClaimType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupUCPercentClaimTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupUCPercentClaimType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupUCPercentCriteria: required: - groupUCPercent_Key - groupUCPercentColumn_Key - groupUCPercentCriteria_Key type: object properties: groupUCPercentCriteria_Key: type: integer description: 'References the GroupUCPercentCriteria.GroupUCPercentCriteria_Key value on the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 criteria_From: maxLength: 64 type: string description: Beginning of selected criteria range. nullable: true criteria_Operator: maxLength: 1 type: string description: 'Defines how the ‘From’ and ‘Thru’ range is treated: inclusive, exclusive, matching, etc.' nullable: true criteria_Thru: maxLength: 64 type: string description: End of selected criteria range. This criterion is only used for the ‘Between’ operation. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time nullable: true entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true groupUCPercentColumn_Key: type: integer description: 'References the GroupUCPercentColumn.GroupUCPercentColumn_Key on the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 groupUCPercent_Key: type: integer description: 'References the GroupUCPercent.GroupUCPercent_Key value on the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: Date when the record was last updated in the system. format: date-time nullable: true update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupUCPercentCriteriaListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupUCPercentCriteria' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupUCPercentCriteriaVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupUCPercentCriteria' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupUCPercentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupUCPercent' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupUCPercentVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupUCPercent' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupVBAPlanTypeSubscriberID: required: - group_ID - groupVBAPlanTypeSubscriberID_Key type: object properties: groupVBAPlanTypeSubscriberID_Key: type: integer description: 'Unique identifier for each Plan Type Sub ID configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: References the Groups.Group_ID value on the parent record. iD_Prefix: maxLength: 8 type: string description: The prefix to be applied to custom VBA Plan Type IDs. nullable: true iD_Suffix: maxLength: 8 type: string description: The suffix to be applied to custom VBA Plan Type IDs. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true vbA_Plan_Type: maxLength: 32 type: string description: 'The VBA Plan Type (Medical, Dental, Vision) to have this ID Prefix/Suffiix applied when generating custom IDs.' nullable: true additionalProperties: false GroupVBAPlanTypeSubscriberIDListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberID' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupVBAPlanTypeSubscriberIDVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupVBAPlanTypeSubscriberID' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupVolume: required: - dist_Volume_Pct - group_ID - groupVolume_Key - use_Dist_Volume type: object properties: groupVolume_Key: type: integer description: 'Unique identifier for each Volume configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 benefit_Code: maxLength: 10 type: string description: 'When configuration is Benefit specific, fill this in. When empty, applies to entire Group/Division/Plan.' nullable: true dist_Volume_Amount: type: number description: 'Based on volume type, this settings determines the volume.' format: double nullable: true dist_Volume_Pct: type: boolean description: 'Based on volume type, this settings determines the volume. Note: This field is marked as NOT NULL in the database and therefore required by the API.' division_ID: maxLength: 20 type: string description: 'When configuration is Division specific, fill this in. When empty, applies to the entire Group.' nullable: true effective_Date: type: string description: The effective date of the volume setting. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true gI_Volume_Max: type: number description: 'Based on volume type, this settings determines the volume.' format: double nullable: true gI_Volume_Min: type: number description: 'Based on volume type, this settings determines the volume.' format: double nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: References Groups.Group_ID value on the parent record. plan_ID: maxLength: 20 type: string description: 'When configuration is Plan specific, fill this in. When empty, applies to entire Group/Division.' nullable: true term_Date: type: string description: The term date for this volume setting. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true use_Dist_Volume: type: boolean description: 'Based on volume type, this settings determines the volume. Note: This field is marked as NOT NULL in the database and therefore required by the API.' volume: type: number description: 'Based on volume type, this settings determines the volume.' format: double nullable: true volume_ID: maxLength: 32 type: string description: This is a User definable field to name the volume being entered. nullable: true volume_Max: type: number description: 'Based on volume type, this settings determines the volume.' format: double nullable: true volume_Min: type: number description: 'Based on volume type, this settings determines the volume.' format: double nullable: true volume_Round_Precision: type: integer description: 'Based on volume type, this settings determines the volume.' format: int32 nullable: true volume_Round_Type: maxLength: 16 type: string description: 'Based on volume type, this settings determines the volume.' nullable: true volume_Type: maxLength: 16 type: string description: This value indicates what setting is used to calculate volume. The fileds that reference this setting are noted and drive the specific volume type. Reference VBASoftware application documentation for detailed explanation. nullable: true volume_Type_From: type: integer description: 'Based on volume type, this settings determines the volume.' format: int32 nullable: true volume_Type_Pct: type: number description: 'Based on volume type, this settings determines the volume.' format: double nullable: true volume_Type_Thru: type: integer description: 'Based on volume type, this settings determines the volume.' format: int32 nullable: true additionalProperties: false GroupVolumeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupVolume' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupVolumeNested: type: object properties: group_ID: type: string nullable: true group_Name: type: string nullable: true divisionConfigs: type: array items: $ref: '#/components/schemas/GroupVolume_DivisionConfig' nullable: true additionalProperties: false GroupVolumeNestedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupVolumeNested' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupVolumeVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupVolume' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupVolume_BenefitConfig: type: object properties: benefit_Code: type: string nullable: true benefit_Description: type: string nullable: true volumes: type: array items: $ref: '#/components/schemas/Volume' nullable: true additionalProperties: false GroupVolume_DivisionConfig: type: object properties: division_ID: type: string nullable: true division_Name: type: string nullable: true planConfigs: type: array items: $ref: '#/components/schemas/GroupVolume_PlanConfig' nullable: true additionalProperties: false GroupVolume_PlanConfig: type: object properties: plan_ID: type: string nullable: true plan_Description: type: string nullable: true benefitConfigs: type: array items: $ref: '#/components/schemas/GroupVolume_BenefitConfig' nullable: true additionalProperties: false Groups: required: - admin_COBRA - advice_To_Pay - apply_Ex_Code - auth_Not_Reqd_Override - coPay_Max_Per_Date_Provider - default_Process_by_Disability_Date - default_Roll_Up_Waiting_Period - disable_COBRA_Auto_Select - duplicate_Claim_Override - group_ID - individual_Billing - individual_Cycle - individual_Dates - open_Closed_Enrollment - paperless - prepaid_Group - prorate_Deduction - self_Admin - set_Billing_Due_Date type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: Unique identifier for each Group. account_Key: type: integer description: Identifies the Account associated with this Group. format: int32 nullable: true account_Manager: maxLength: 128 type: string description: Information field used in custom client reporting. nullable: true addOn_Rate_Option: maxLength: 8 type: string description: 'Determines whether a Group''s AddOn Rates are combined and applied once (Additive) or applies rates separately, in a sequence (Sequential).' nullable: true address: maxLength: 255 type: string description: Adderss of the Group. nullable: true address2: maxLength: 128 type: string description: Line 2 of the Group's address. nullable: true admin_COBRA: type: boolean description: 'Indicates if this Group administers COBRA. Note: This field is marked as NOT NULL in the database and therefore required by the API.' adult_Age: type: integer description: Identifies the age at which dependents are considered to be adults. Student status information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here. format: int32 nullable: true advice_To_Pay: type: boolean description: 'Notes if the claims for this Group should be Advice_To_Pay (flagged as unpaid when processed). Note: This field is marked as NOT NULL in the database and therefore required by the API.' apply_Ex_Code: type: boolean description: 'Flag if adjudication should apply an Ex Code to a claim for this Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.' auth_Not_Reqd_Override: type: boolean description: 'Notes if this group allows Auth Required claims edit to be overridden and paid. Note: This field is marked as NOT NULL in the database and therefore required by the API.' billing_Age_Calc: maxLength: 1 type: string description: No longer in use. Replaced by Premium Billing module. nullable: true billing_Cycle_ID: maxLength: 2 type: string description: Identifies the bill cycle for this Group. This will be used when creating invoices. nullable: true billing_Due_Date_Range: type: integer description: Used when Set_Billing_Due_Date is enabled. format: int32 nullable: true billing_Due_Date_Range_Type: maxLength: 16 type: string description: Used when Set_Billing_Due_Date is enabled. nullable: true billing_Due_Date_Type: maxLength: 32 type: string description: Used when Set_Billing_Due_Date is enabled. nullable: true billing_Invoice_Create: type: integer description: Indicates the group is included in invoice generation processes. format: int32 nullable: true billing_Retro_Limit: type: integer description: Indicates how many bills (based on billing cycles) should be interrogated to determine adjustments. format: int32 nullable: true caseRate: type: number description: No longer in use. format: double nullable: true check_Birthday: maxLength: 1 type: string description: Identifies whether date of birth edits are performed for this Group during adjudication. nullable: true city: maxLength: 25 type: string description: City of the Group's address. nullable: true claim_Days_Allowed: type: integer description: No longer in use. format: int32 nullable: true coPay_Max_Per_Date_Provider: type: boolean description: 'Notes that this group calculates copay max (based on plan configuration) by provider rather than across the entire plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' commission_Lookback: type: integer description: Notes the number of billing cycles to lookback when calculating commissions. format: int32 nullable: true contact_Country_Code: maxLength: 8 type: string description: Country code of the Group's contact number. nullable: true contact_Email_Address: maxLength: 128 type: string description: Email address of the identified Group contact. nullable: true contact_Extension: maxLength: 6 type: string description: Extension number of the Group's contact. nullable: true contact_Phone: maxLength: 20 type: string description: Phone number of the Group's contact. nullable: true contact_Title: maxLength: 20 type: string description: Title of the Group's primary contact. nullable: true country_ID: maxLength: 8 type: string description: Identifier of the Groups's country. nullable: true county_Code: maxLength: 8 type: string description: County code of the Group address. nullable: true cutoff_Age: type: integer description: Identifies the age at which dependents are no longer eligible for coverage. Adult Dependent information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here. format: int32 nullable: true default_EOB_Report: type: integer description: Defines the default EOB report object from our core admin system. This is a developer setting. format: int32 nullable: true default_Invoice_ReportDefinition_Key: type: integer description: 'By default, indicates which Invoice report should be used for automation.' format: int32 nullable: true default_Process_by_Disability_Date: type: boolean description: 'Process by Disability Date can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default). Note: This field is marked as NOT NULL in the database and therefore required by the API.' default_Roll_Up_Waiting_Period: type: boolean description: 'Roll Up Waiting Period can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default). Note: This field is marked as NOT NULL in the database and therefore required by the API.' disability_Pay_Through_Day: type: integer description: The day of the week that Paid Through is calculated for Disability premiums. format: int32 nullable: true disable_COBRA_Auto_Select: type: boolean description: 'This flag indicates that the Group COBRA premium will not be automatically populated during member disenrollment. Note: This field is marked as NOT NULL in the database and therefore required by the API.' disenroll_Date: type: string description: Date when the Group expires/expired. format: date-time nullable: true distribution_Account_Key: type: integer description: 'For Premium Distribution processing, this notes the Account for the source of distributed funds.' format: int32 nullable: true distribution_Payor_ID: maxLength: 20 type: string description: 'For Premium Distribution processing, this notes the Payor ID for the source of distributed funds.' nullable: true duplicate_Claim_Override: type: boolean description: 'Notes if this group allows Duplicate Claims to be overridden to be paid. Note: This field is marked as NOT NULL in the database and therefore required by the API.' election_Range: type: integer description: Used for determining Flex Election. format: int32 nullable: true election_Range_Type: maxLength: 16 type: string description: Used with Election_Range to determine the Flex Election. nullable: true employer_Size: maxLength: 8 type: string description: Information field used in custom client reporting. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: The Ex Code applied during claims adjudication if "Apply_Ex_Code" is enabled. nullable: true fax: maxLength: 20 type: string description: Fax number of the Group. nullable: true fax_Country_Code: maxLength: 8 type: string description: Country code of the Group's fax number. nullable: true federal_ID: maxLength: 20 type: string description: Federal tax identifier of the Group. nullable: true generate_Adjustments: maxLength: 1 type: string description: No longer in use. Replaced by Premium Billing module. nullable: true generate_Invoices: maxLength: 1 type: string description: No longer in use. Replaced by Premium Billing module. nullable: true group_Account: type: integer description: Holds the account reference for the Employer Account. Not used in processing. format: int32 nullable: true individual_Billing: type: boolean description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' individual_Cycle: type: boolean description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' individual_Dates: type: boolean description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' inv_Grace_Period: type: integer description: The grace period value based on "Grace_Period_Type" for how long you have to process an invoice after the term date. format: int32 nullable: true inv_Grace_Period_Type: maxLength: 1 type: string description: Works with Grace_Period to determine how long after term date an invoice can be processed. nullable: true invoice_Enrolled_By: type: integer description: Used to determine eligiblity during invoice generation for enrolled members. format: int32 nullable: true invoice_Enrolled_Thru: type: integer description: Used to determine eligiblity during invoice generation for enrolled members. format: int32 nullable: true issue_State: maxLength: 2 type: string description: Identifies the sate in which the Group is insured. nullable: true name: maxLength: 50 type: string description: Name of the Group. nullable: true notes: type: string description: 'No longer in use, replaced by Notes Service.' nullable: true open_Closed_Enrollment: type: boolean description: 'Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.' original_Date: type: string description: Date when the Group becomes/became active. format: date-time nullable: true paid_Through: type: string description: Date through which the Group premium has been paid. format: date-time nullable: true paperless: type: boolean description: 'Notes if this Group is Paperless (this overrides the individual member settings from VBAGateway). Used in process automation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' pay_To_Account: type: integer description: The Pay To Account used for external payments. format: int32 nullable: true payor_ID: maxLength: 20 type: string description: Identifier of the Payor associated with the Group. nullable: true phone: maxLength: 20 type: string description: Phone number of the Group. nullable: true phone_Country_Code: maxLength: 8 type: string description: Country code of the Group's phone number. nullable: true prepaid_Group: type: boolean description: 'Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.' primary_Contact: maxLength: 25 type: string description: Primary contact of the Group. nullable: true producer: maxLength: 128 type: string description: Information field used in custom client reporting. nullable: true prorate_Deduction: type: boolean description: 'Notes if the disability deductions should be prorated during adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.' prorate_Deduction_Type: maxLength: 10 type: string description: 'For Disability, notes the Deduction Type to have prorate applied.' nullable: true rX_BIN: maxLength: 64 type: string description: Information field used in custom client reporting. nullable: true rX_CS_Contact: maxLength: 128 type: string description: Information field used in custom client reporting. nullable: true rX_CS_Phone: maxLength: 32 type: string description: Information field used in custom client reporting. nullable: true rX_GRP: maxLength: 64 type: string description: Information field used in custom client reporting. nullable: true rX_Name: maxLength: 512 type: string description: Information field used in custom client reporting. nullable: true rX_PCN: maxLength: 64 type: string description: Information field used in custom client reporting. nullable: true reason_ID: type: integer description: No longer in use. format: int32 nullable: true region_Code: maxLength: 32 type: string description: Region Code for this group (locality). nullable: true renewal_Completion_Date: type: string description: Information field used in custom client reporting. format: date-time nullable: true renewal_Date: type: string description: The last renewal date for this Group. Used in custom reporting. Not used in processing. format: date-time nullable: true self_Admin: type: boolean description: 'Notes if this group has Self-Admin billing. Note: This field is marked as NOT NULL in the database and therefore required by the API.' set_Billing_Due_Date: type: boolean description: 'Indicates if the system should calculate the Due Date on an invoice based on Billing_Due_Date settings. By default the due date is the "Bill Thru" on an invoice, this gives the option to change that calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' state: maxLength: 2 type: string description: State of the Group's address. nullable: true subscriber_ID_Prefix: maxLength: 3 type: string description: The automatically applied Subscriber ID prefix when using auto generated IDs. nullable: true subscriber_ID_Suffix: maxLength: 3 type: string description: The automatically applied Subscriber ID suffix when using auto generated IDs. nullable: true total_Employees: type: integer description: Information field used in custom client reporting. format: int32 nullable: true uC_Percent: maxLength: 8 type: string description: Identifies the Usual and Customary percentage of the Group. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true use_Employer_State: type: boolean description: 'Notes if Employe State, not Subscriber State, should be used in invoice generation. Note: The database will apply a default value of `False` for this field if a value is not provided.' nullable: true zip_Code: maxLength: 32 type: string description: Zip code of the Group's address. nullable: true additionalProperties: false GroupsListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Groups' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupsParticipationIncentive: required: - groupsParticipationIncentive_Key - participationIncentive_ID type: object properties: groupsParticipationIncentive_Key: type: integer description: 'Unique indicator for each Participation Incentive record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 2048 type: string description: The description of the incentive being added. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true participationIncentive_ID: maxLength: 32 minLength: 1 type: string description: The participation incentive ID used for this setting. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false GroupsParticipationIncentiveListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupsParticipationIncentive' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupsParticipationIncentiveVBAResponse: type: object properties: data: $ref: '#/components/schemas/GroupsParticipationIncentive' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false GroupsVBAResponse: type: object properties: data: $ref: '#/components/schemas/Groups' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAAAdjustmentCode: required: - hipaA_Code type: object properties: hipaA_Code: maxLength: 8 minLength: 1 type: string description: Code identifying the HIPAA Adjustment description: maxLength: 512 type: string description: Description of the HIPAA Adjustment nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false HIPAAAdjustmentCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/HIPAAAdjustmentCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAAAdjustmentCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/HIPAAAdjustmentCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAABenefitCode: required: - hipaA_Code type: object properties: hipaA_Code: maxLength: 8 minLength: 1 type: string description: Code identifying the HIPAA Benefit Code description: maxLength: 512 type: string description: Description of the HIPAA Benefit Code nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false HIPAABenefitCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/HIPAABenefitCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAABenefitCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/HIPAABenefitCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAAClaimStatusCategoryCode: required: - hipaA_Code type: object properties: hipaA_Code: maxLength: 8 minLength: 1 type: string description: Code identifying the HIPAA Claim Status Category description: maxLength: 512 type: string description: Description of the HIPAA Claim Status Category nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false HIPAAClaimStatusCategoryCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAAClaimStatusCategoryCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/HIPAAClaimStatusCategoryCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAAClaimStatusCode: required: - hipaA_Code type: object properties: hipaA_Code: maxLength: 8 minLength: 1 type: string description: Code identifying the HIPAA Claim Status description: maxLength: 512 type: string description: Description of the HIPAA Claim Status nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false HIPAAClaimStatusCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/HIPAAClaimStatusCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAAClaimStatusCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/HIPAAClaimStatusCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAAPlanType: required: - hipaA_Code type: object properties: hipaA_Code: maxLength: 8 minLength: 1 type: string description: Code identifying the HIPAA Plan Type description: maxLength: 512 type: string description: Description of the HIPAA Plan Type nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false HIPAAPlanTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/HIPAAPlanType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAAPlanTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/HIPAAPlanType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAAReason: required: - hipaA_Code type: object properties: hipaA_Code: maxLength: 8 minLength: 1 type: string description: Code identifying the HIPAA enrollment change reason description: maxLength: 512 type: string description: Description of the HIPAA enrollment change reason nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false HIPAAReasonListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/HIPAAReason' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAAReasonVBAResponse: type: object properties: data: $ref: '#/components/schemas/HIPAAReason' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAARelationship: required: - hipaA_Code type: object properties: hipaA_Code: maxLength: 8 minLength: 1 type: string description: Code identifying the HIPAA family relationship description: maxLength: 512 type: string description: Description of the HIPAA family relationship nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false HIPAARelationshipListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/HIPAARelationship' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAARelationshipVBAResponse: type: object properties: data: $ref: '#/components/schemas/HIPAARelationship' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAATier: required: - hipaA_Code type: object properties: hipaA_Code: maxLength: 8 minLength: 1 type: string description: Code identifying the HIPAA tier description: maxLength: 512 type: string description: Description of the HIPAA tier nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false HIPAATierListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/HIPAATier' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false HIPAATierVBAResponse: type: object properties: data: $ref: '#/components/schemas/HIPAATier' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IDCardRequest: required: - idCardRequest_Key - renewal type: object properties: idCardRequest_Key: type: integer description: 'Key value of the ID Card request Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 as_Of_Date: type: string description: Date the ID card will be effective format: date-time nullable: true cancellation_Reason: maxLength: 256 type: string description: Reason indicating why the ID Card Request was cancelled nullable: true card_Record_Status: maxLength: 3 type: string description: Status of the card nullable: true division_ID: maxLength: 20 type: string description: Division ID of the subscriber enrollment for the ID card nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true group_ID: maxLength: 20 type: string description: Group ID of the subscriber enrollment for the ID card nullable: true issuance_Type: maxLength: 3 type: string description: Issuance type of the ID card nullable: true member_Seq: maxLength: 2 type: string description: Member Sequence of the family member for the ID card nullable: true renewal: type: boolean description: 'Flag indicating the ID card request was for a renewal Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' request_Date: type: string description: Date the ID card was requested format: date-time nullable: true request_Quantity: type: integer description: Quantity of ID cards requested format: int32 nullable: true request_Status: maxLength: 16 type: string description: Status of the ID card request nullable: true request_Type: maxLength: 16 type: string description: Identifier for the ID card request type or source nullable: true subscriber_ID: maxLength: 9 type: string description: Subscriber ID of the subscriber for the ID card nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false IDCardRequestListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/IDCardRequest' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IDCardRequestType: required: - request_Type type: object properties: request_Type: maxLength: 16 minLength: 1 type: string description: Name for the request type. description: maxLength: 50 type: string description: Description of the request type. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false IDCardRequestTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/IDCardRequestType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IDCardRequestTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/IDCardRequestType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IDCardRequestVBAResponse: type: object properties: data: $ref: '#/components/schemas/IDCardRequest' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IDCodeCriteria: type: object properties: iD_Code: type: string nullable: true type: type: string nullable: true iD_Code_Data: type: string nullable: true iD_Code_Data_Date: type: string format: date-time nullable: true iD_Code_Data_Number: type: integer format: int32 nullable: true iD_Code_Data_Decimal: type: number format: double nullable: true iD_Code_Data_Option: type: boolean nullable: true additionalProperties: false IDCodeType: required: - edI_Code - iD_Code - system_Code - type - type_Default type: object properties: iD_Code: maxLength: 16 minLength: 1 type: string description: Identifier for a specific ID Code type: maxLength: 16 minLength: 1 type: string description: Type of the ID Code dataType: maxLength: 64 type: string description: Data type of the data portion of the ID Code nullable: true description: maxLength: 64 type: string description: Description of the ID Code nullable: true edI_Code: type: boolean description: 'Flag indicating the ID Code is used for EDI transactions Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true format: maxLength: 128 type: string description: Format of the data portion of the ID Code nullable: true length: type: integer description: Length of the data portion of the ID Code format: int32 nullable: true system_Code: type: boolean description: 'Flag indicating the ID Code is part of the base application Note: This field is marked as NOT NULL in the database and therefore required by the API.' type_Default: type: boolean description: 'This is a flag indicating an ID Code/Type combination that should be automatically populated, if not already, when opening the ID Codes screen from the appropriate area. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false IDCodeTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/IDCodeType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IDCodeTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/IDCodeType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IDCodeValue: required: - iD_Code - idCodeValue_Key - type type: object properties: idCodeValue_Key: type: integer description: 'Key value identifying a specific ID Code value Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true iD_Code: maxLength: 16 minLength: 1 type: string description: Identifier for a specific ID Code iD_Code_Data: maxLength: 500 type: string description: Data value for the ID Code when it is a string nullable: true iD_Code_Data_Date: type: string description: Data value for the ID Code when it is a datetime field format: date-time nullable: true iD_Code_Data_Decimal: type: number description: Data value for the ID Code when it is a decimal format: double nullable: true iD_Code_Data_Number: type: integer description: Data value for the ID Code when it is a integer format: int32 nullable: true iD_Code_Data_Option: type: boolean description: Data value for the ID Code when it is a bit nullable: true key_Column1: maxLength: 128 type: string description: Key value column name that the ID Code is associated with nullable: true key_Column2: maxLength: 128 type: string description: Additional key value column name that the ID Code is associated with (if needed) nullable: true key_Column3: maxLength: 128 type: string description: Additional key value column name that the ID Code is associated with (if needed) nullable: true key_Column4: maxLength: 128 type: string description: Additional key value column name that the ID Code is associated with (if needed) nullable: true key_Column5: maxLength: 128 type: string description: Additional key value column name that the ID Code is associated with (if needed) nullable: true key_DataType1: maxLength: 32 type: string description: Data type of the key value column the ID Code is associated with nullable: true key_DataType2: maxLength: 32 type: string description: Additional data type of the key value column the ID Code is associated with (if needed) nullable: true key_DataType3: maxLength: 32 type: string description: Additional data type of the key value column the ID Code is associated with (if needed) nullable: true key_DataType4: maxLength: 32 type: string description: Additional data type of the key value column the ID Code is associated with (if needed) nullable: true key_DataType5: maxLength: 32 type: string description: Additional data type of the key value column the ID Code is associated with (if needed) nullable: true key_Value1: maxLength: 128 type: string description: Value of the key value column the ID Code is associated with nullable: true key_Value2: maxLength: 128 type: string description: Additional value of the key value column the ID Code is associated with (if needed) nullable: true key_Value3: maxLength: 128 type: string description: Additional value of the key value column the ID Code is associated with (if needed) nullable: true key_Value4: maxLength: 128 type: string description: Additional value of the key value column the ID Code is associated with (if needed) nullable: true key_Value5: maxLength: 128 type: string description: Additional value of the key value column the ID Code is associated with (if needed) nullable: true type: maxLength: 16 minLength: 1 type: string description: Type of the ID Code update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false IDCodeValueListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/IDCodeValue' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IDCodeValueVBAResponse: type: object properties: data: $ref: '#/components/schemas/IDCodeValue' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IDCodeValue_ResultBySource: type: object properties: idCodeValue_Key: type: integer format: int32 nullable: true iD_Code: type: string nullable: true iD_Code_Description: type: string nullable: true type: type: string nullable: true type_Description: type: string nullable: true dataType: type: string nullable: true iD_Code_Data_String: type: string nullable: true iD_Code_Data_Date: type: string format: date-time nullable: true iD_Code_Data_Number: type: integer format: int32 nullable: true iD_Code_Data_Decimal: type: number format: double nullable: true iD_Code_Data_Option: type: boolean nullable: true additionalProperties: false IDCodeValue_ResultBySourceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/IDCodeValue_ResultBySource' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IDType: required: - type type: object properties: type: maxLength: 16 minLength: 1 type: string description: Name for the ID type. description: maxLength: 128 type: string description: Description of the ID type. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false IDTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/IDType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IDTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/IDType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IPWhitelist: required: - description - iP_Address - ipWhitelist_Key type: object properties: ipWhitelist_Key: type: integer description: 'Identity key for the record. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 description: maxLength: 1024 minLength: 1 type: string description: User-defined description for the record to help identify the reason for usage. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true iP_Address: maxLength: 39 minLength: 1 type: string description: "IP Address that will be whitelisted for accessing the APIs. This field supports both single IPv4 addresses and CIDR blocks for specifying IP ranges. \r\n\r\n- **Single IP Address:** Provide a specific IPv4 address (e.g., \"192.168.1.1\") to whitelist that single address.\r\n- **CIDR Block:** Provide a CIDR block (e.g., \"192.168.1.0/24\") to whitelist a range of addresses. \r\n \r\nNotes:\r\n- The value must be unique within the whitelist.\r\n- The maximum length of this field is 39 characters to accommodate IPv4 addresses and CIDR notation.\r\n- Ensure that the provided IP address or CIDR block is correctly formatted to avoid validation errors." update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false IPWhitelistListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/IPWhitelist' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IPWhitelistVBAResponse: type: object properties: data: $ref: '#/components/schemas/IPWhitelist' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IRS1094C: required: - group_ID - tax_Year type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: Unique ID for the Group tax_Year: maxLength: 4 minLength: 1 type: string description: Year that is covered by the 1094-C reporting aggregated_Group_Member_Cd: maxLength: 1 type: string description: Code identifying an Aggregated Group Member nullable: true apr_ALE_Member_FTE_Cnt: type: integer description: Applicable Large Employer full-time employee count for the specified month format: int32 nullable: true apr_ALE_Sect_4980H_Trnst_Relief_Cd: maxLength: 1 type: string description: Indicator for ALE Section 4980h relief code for the specified month nullable: true apr_Aggregated_Group_Ind: maxLength: 1 type: string description: Flag indicating if the ALE member was an Aggregated ALE Group Member for the specified month nullable: true apr_Min_Essential_Cvr_Offr_Cd: maxLength: 1 type: string description: Code indicating if the ALE Member offered minimum essential coverage for the specified month nullable: true apr_Total_Employee_Cnt: type: integer description: Total employee count (including full-time and non-full-time) for the specified month format: int32 nullable: true aug_ALE_Member_FTE_Cnt: type: integer description: Applicable Large Employer full-time employee count for the specified month format: int32 nullable: true aug_ALE_Sect_4980H_Trnst_Relief_Cd: maxLength: 1 type: string description: Indicator for ALE Section 4980h relief code for the specified month nullable: true aug_Aggregated_Group_Ind: maxLength: 1 type: string description: Flag indicating if the ALE member was an Aggregated ALE Group Member for the specified month nullable: true aug_Min_Essential_Cvr_Offr_Cd: maxLength: 1 type: string description: Code indicating if the ALE Member offered minimum essential coverage for the specified month nullable: true aug_Total_Employee_Cnt: type: integer description: Total employee count (including full-time and non-full-time) for the specified month format: int32 nullable: true authoritative_Transmittal_Ind: maxLength: 1 type: string description: Indicator for an Authoritative Transmittal nullable: true dec_ALE_Member_FTE_Cnt: type: integer description: Applicable Large Employer full-time employee count for the specified month format: int32 nullable: true dec_ALE_Sect_4980H_Trnst_Relief_Cd: maxLength: 1 type: string description: Indicator for ALE Section 4980h relief code for the specified month nullable: true dec_Aggregated_Group_Ind: maxLength: 1 type: string description: Flag indicating if the ALE member was an Aggregated ALE Group Member for the specified month nullable: true dec_Min_Essential_Cvr_Offr_Cd: maxLength: 1 type: string description: Code indicating if the ALE Member offered minimum essential coverage for the specified month nullable: true dec_Total_Employee_Cnt: type: integer description: Total employee count (including full-time and non-full-time) for the specified month format: int32 nullable: true feb_ALE_Member_FTE_Cnt: type: integer description: Applicable Large Employer full-time employee count for the specified month format: int32 nullable: true feb_ALE_Sect_4980H_Trnst_Relief_Cd: maxLength: 1 type: string description: Indicator for ALE Section 4980h relief code for the specified month nullable: true feb_Aggregated_Group_Ind: maxLength: 1 type: string description: Flag indicating if the ALE member was an Aggregated ALE Group Member for the specified month nullable: true feb_Min_Essential_Cvr_Offr_Cd: maxLength: 1 type: string description: Code indicating if the ALE Member offered minimum essential coverage for the specified month nullable: true feb_Total_Employee_Cnt: type: integer description: Total employee count (including full-time and non-full-time) for the specified month format: int32 nullable: true jan_ALE_Member_FTE_Cnt: type: integer description: Applicable Large Employer full-time employee count for the specified month format: int32 nullable: true jan_ALE_Sect_4980H_Trnst_Relief_Cd: maxLength: 1 type: string description: Indicator for ALE Section 4980h relief code for the specified month nullable: true jan_Aggregated_Group_Ind: maxLength: 1 type: string description: Flag indicating if the ALE member was an Aggregated ALE Group Member for the specified month nullable: true jan_Min_Essential_Cvr_Offr_Cd: maxLength: 1 type: string description: Code indicating if the ALE Member offered minimum essential coverage for the specified month nullable: true jan_Total_Employee_Cnt: type: integer description: Total employee count (including full-time and non-full-time) for the specified month format: int32 nullable: true jul_ALE_Member_FTE_Cnt: type: integer description: Applicable Large Employer full-time employee count for the specified month format: int32 nullable: true jul_ALE_Sect_4980H_Trnst_Relief_Cd: maxLength: 1 type: string description: Indicator for ALE Section 4980h relief code for the specified month nullable: true jul_Aggregated_Group_Ind: maxLength: 1 type: string description: Flag indicating if the ALE member was an Aggregated ALE Group Member for the specified month nullable: true jul_Min_Essential_Cvr_Offr_Cd: maxLength: 1 type: string description: Code indicating if the ALE Member offered minimum essential coverage for the specified month nullable: true jul_Total_Employee_Cnt: type: integer description: Total employee count (including full-time and non-full-time) for the specified month format: int32 nullable: true jun_ALE_Member_FTE_Cnt: type: integer description: Applicable Large Employer full-time employee count for the specified month format: int32 nullable: true jun_ALE_Sect_4980H_Trnst_Relief_Cd: maxLength: 1 type: string description: Indicator for ALE Section 4980h relief code for the specified month nullable: true jun_Aggregated_Group_Ind: maxLength: 1 type: string description: Flag indicating if the ALE member was an Aggregated ALE Group Member for the specified month nullable: true jun_Min_Essential_Cvr_Offr_Cd: maxLength: 1 type: string description: Code indicating if the ALE Member offered minimum essential coverage for the specified month nullable: true jun_Total_Employee_Cnt: type: integer description: Total employee count (including full-time and non-full-time) for the specified month format: int32 nullable: true jurat_Signature_PIN: maxLength: 20 type: string description: Jurat Signature PIN nullable: true mar_ALE_Member_FTE_Cnt: type: integer description: Applicable Large Employer full-time employee count for the specified month format: int32 nullable: true mar_ALE_Sect_4980H_Trnst_Relief_Cd: maxLength: 1 type: string description: Indicator for ALE Section 4980h relief code for the specified month nullable: true mar_Aggregated_Group_Ind: maxLength: 1 type: string description: Flag indicating if the ALE member was an Aggregated ALE Group Member for the specified month nullable: true mar_Min_Essential_Cvr_Offr_Cd: maxLength: 1 type: string description: Code indicating if the ALE Member offered minimum essential coverage for the specified month nullable: true mar_Total_Employee_Cnt: type: integer description: Total employee count (including full-time and non-full-time) for the specified month format: int32 nullable: true may_ALE_Member_FTE_Cnt: type: integer description: Applicable Large Employer full-time employee count for the specified month format: int32 nullable: true may_ALE_Sect_4980H_Trnst_Relief_Cd: maxLength: 1 type: string description: Indicator for ALE Section 4980h relief code for the specified month nullable: true may_Aggregated_Group_Ind: maxLength: 1 type: string description: Flag indicating if the ALE member was an Aggregated ALE Group Member for the specified month nullable: true may_Min_Essential_Cvr_Offr_Cd: maxLength: 1 type: string description: Code indicating if the ALE Member offered minimum essential coverage for the specified month nullable: true may_Total_Employee_Cnt: type: integer description: Total employee count (including full-time and non-full-time) for the specified month format: int32 nullable: true ninetyEight_Pct_Offer_Method_Ind: maxLength: 1 type: string description: Indicator for the 98% Offer Method nullable: true nov_ALE_Member_FTE_Cnt: type: integer description: Applicable Large Employer full-time employee count for the specified month format: int32 nullable: true nov_ALE_Sect_4980H_Trnst_Relief_Cd: maxLength: 1 type: string description: Indicator for ALE Section 4980h relief code for the specified month nullable: true nov_Aggregated_Group_Ind: maxLength: 1 type: string description: Flag indicating if the ALE member was an Aggregated ALE Group Member for the specified month nullable: true nov_Min_Essential_Cvr_Offr_Cd: maxLength: 1 type: string description: Code indicating if the ALE Member offered minimum essential coverage for the specified month nullable: true nov_Total_Employee_Cnt: type: integer description: Total employee count (including full-time and non-full-time) for the specified month format: int32 nullable: true oct_ALE_Member_FTE_Cnt: type: integer description: Applicable Large Employer full-time employee count for the specified month format: int32 nullable: true oct_ALE_Sect_4980H_Trnst_Relief_Cd: maxLength: 1 type: string description: Indicator for ALE Section 4980h relief code for the specified month nullable: true oct_Aggregated_Group_Ind: maxLength: 1 type: string description: Flag indicating if the ALE member was an Aggregated ALE Group Member for the specified month nullable: true oct_Min_Essential_Cvr_Offr_Cd: maxLength: 1 type: string description: Code indicating if the ALE Member offered minimum essential coverage for the specified month nullable: true oct_Total_Employee_Cnt: type: integer description: Total employee count (including full-time and non-full-time) for the specified month format: int32 nullable: true person_Title_Txt: maxLength: 100 type: string description: Person Title Text nullable: true qlfy_Offer_Method_Trnst_Relief_Ind: maxLength: 1 type: string description: Indicator for the Qulaifying Offer Method for Transmittal Relief nullable: true qualifying_Offer_Method_Ind: maxLength: 1 type: string description: Indicator for the Qualifying Offer Method nullable: true section_4980H_Relief_Ind: maxLength: 1 type: string description: Indicator for Section 4980h Relief nullable: true sep_ALE_Member_FTE_Cnt: type: integer description: Applicable Large Employer full-time employee count for the specified month format: int32 nullable: true sep_ALE_Sect_4980H_Trnst_Relief_Cd: maxLength: 1 type: string description: Indicator for ALE Section 4980h relief code for the specified month nullable: true sep_Aggregated_Group_Ind: maxLength: 1 type: string description: Flag indicating if the ALE member was an Aggregated ALE Group Member for the specified month nullable: true sep_Min_Essential_Cvr_Offr_Cd: maxLength: 1 type: string description: Code indicating if the ALE Member offered minimum essential coverage for the specified month nullable: true sep_Total_Employee_Cnt: type: integer description: Total employee count (including full-time and non-full-time) for the specified month format: int32 nullable: true signature_Dt: type: string description: Date of the signature format: date-time nullable: true total_Form_1095C_ALE_Member_Cnt: type: integer description: Total count for Applicable Large Employer Member format: int32 nullable: true yearly_ALE_Member_FTE_Cnt: type: integer description: Applicable Large Employer full-time employee count for the year format: int32 nullable: true yearly_ALE_Sect_4980H_Trnst_Relief_Cd: maxLength: 1 type: string description: Indicator for ALE Section 4980h relief code for the year nullable: true yearly_Aggregated_Group_Ind: maxLength: 1 type: string description: Flag indicating if the ALE member was an Aggregated ALE Group Member for any month of the year nullable: true yearly_Min_Essential_Cvr_Offr_Cd: maxLength: 1 type: string description: Code indicating if the ALE Member offered minimum essential coverage for the year nullable: true yearly_Total_Employee_Cnt: type: integer description: Total employee count (including full-time and non-full-time) for the year format: int32 nullable: true additionalProperties: false IRS1094CListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/IRS1094C' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IRS1094CVBAResponse: type: object properties: data: $ref: '#/components/schemas/IRS1094C' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IRS1095B: required: - group_ID - tax_Year type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: ID of the group filing the IRS 1095B form tax_Year: maxLength: 4 minLength: 1 type: string description: Tax year for the filing of the IRS 1095B form insurer_Business_Name_Control_Txt: maxLength: 4 type: string description: Business name (control text) of the insurer that covered the employee nullable: true insurer_Business_Name_Line1_Txt: maxLength: 75 type: string description: Business name (line 1) of the insurer that covered the employee nullable: true insurer_Business_Name_Line2_Txt: maxLength: 75 type: string description: Business name (line 2) of the insurer that covered the employee nullable: true insurer_Contact_Phone_Num: maxLength: 15 type: string description: Main contact phone number for the insurer nullable: true insurer_EIN: maxLength: 9 type: string description: EIN of the insurer nullable: true insurer_TIN_Request_Type_Cd: maxLength: 14 type: string description: Code specifying the insurers TIN request type nullable: true insurer_US_Address_Line1_Txt: maxLength: 35 type: string description: Business address (line 1) of the insurer that covered the employee nullable: true insurer_US_Address_Line2_Txt: maxLength: 35 type: string description: Business address (line 2) of the insurer that covered the employee nullable: true insurer_US_City: maxLength: 22 type: string description: City of the insurer that covered the employee nullable: true insurer_US_State: maxLength: 2 type: string description: State of the insurer that covered the employee nullable: true insurer_US_Zip: maxLength: 5 type: string description: 5 digit Zip code of the insurer that covered the employee nullable: true insurer_US_Zip_4: maxLength: 4 type: string description: 4 digit Zip code extenstion of the insurer that covered the employee nullable: true additionalProperties: false IRS1095BListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/IRS1095B' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IRS1095BVBAResponse: type: object properties: data: $ref: '#/components/schemas/IRS1095B' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false InsuranceCarrier: required: - carrier_ID - carrier_Key type: object properties: carrier_Key: type: integer format: int32 address: maxLength: 255 type: string nullable: true address2: maxLength: 128 type: string nullable: true coB_Carrier: maxLength: 1 type: string nullable: true carrier_ID: maxLength: 16 minLength: 1 type: string carrier_Type: maxLength: 6 type: string nullable: true city: maxLength: 64 type: string nullable: true contact_Fax: maxLength: 32 type: string nullable: true contact_Fax_Country_Code: maxLength: 8 type: string nullable: true contact_Name: maxLength: 64 type: string nullable: true contact_Phone: maxLength: 32 type: string nullable: true contact_Phone_Country_Code: maxLength: 8 type: string nullable: true country_ID: maxLength: 8 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true fax: maxLength: 32 type: string nullable: true fax_Country_Code: maxLength: 8 type: string nullable: true malpractice: maxLength: 1 type: string nullable: true medicare: type: boolean nullable: true name: maxLength: 64 type: string nullable: true over_Spec_Advance_Fund: type: number format: double nullable: true phone: maxLength: 32 type: string nullable: true phone_Country_Code: maxLength: 8 type: string nullable: true reinsurance: maxLength: 1 type: string nullable: true state: maxLength: 32 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true zip: maxLength: 32 type: string nullable: true additionalProperties: false InsuranceCarrierListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/InsuranceCarrier' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false InsuranceCarrierType: required: - carrier_Type type: object properties: carrier_Type: maxLength: 6 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false InsuranceCarrierTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/InsuranceCarrierType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false InsuranceCarrierTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/InsuranceCarrierType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false InsuranceCarrierVBAResponse: type: object properties: data: $ref: '#/components/schemas/InsuranceCarrier' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false InsuranceType: required: - insurance_Type type: object properties: insurance_Type: type: integer format: int32 description: maxLength: 64 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false InsuranceTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/InsuranceType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false InsuranceTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/InsuranceType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Int32StaticOption: type: object properties: option_Key: type: integer format: int32 display: type: string nullable: true description: type: string nullable: true additionalProperties: false Int32StaticOptionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Int32StaticOption' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Int32StaticOptionVBAResponse: type: object properties: data: $ref: '#/components/schemas/Int32StaticOption' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Int32VBAResponse: type: object properties: data: type: integer format: int32 error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false InvoiceReason: required: - reason_Key type: object properties: reason_Key: type: integer description: 'Unique identifier for the Reason Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 64 type: string description: Description of the Reason nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false InvoiceReasonListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/InvoiceReason' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false InvoiceReasonVBAResponse: type: object properties: data: $ref: '#/components/schemas/InvoiceReason' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IssueDurationValue: required: - issueDurationValue_Key type: object properties: issueDurationValue_Key: type: integer description: Key value identifying the Issue Duration Value format: int32 description: maxLength: 512 type: string description: Description of Issue Duration - Cash Value or Reduced Paid Up nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true type: maxLength: 8 type: string description: Type of Issue Duration - CV or RPU nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false IssueDurationValueListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/IssueDurationValue' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false IssueDurationValueVBAResponse: type: object properties: data: $ref: '#/components/schemas/IssueDurationValue' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Job: required: - job_ID type: object properties: job_ID: maxLength: 32 minLength: 1 type: string description: Identifier for the specific job that will be run criteria_Object: maxLength: 128 type: string description: Criteria object used with the job to supply the paramters when it is run nullable: true description: maxLength: 512 type: string description: Description for the job that will be run nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true job_Type: maxLength: 32 type: string description: Identifier for the type of job nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false JobExecution: required: - job_ID - jobExecution_Key type: object properties: jobExecution_Key: type: integer description: 'Key value identifying an instance of the execution of the job Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true job_Execute_Date: type: string description: Date the job was executed format: date-time nullable: true job_Execute_User: maxLength: 20 type: string description: User that executed this instance of the job nullable: true job_ID: maxLength: 32 minLength: 1 type: string description: Identifier for the specific job that is run update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true vbA_Execute_End: type: string description: Date and time the instance of execution ended format: date-time nullable: true vbA_Execute_Result: maxLength: 32 type: string description: Result of the instance of execution nullable: true vbA_Execute_Result_Message: type: string description: Messages or files that were captured from the instance of execution nullable: true vbA_Execute_Start: type: string description: Date and time the instance of execution started format: date-time nullable: true additionalProperties: false JobExecutionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/JobExecution' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false JobExecutionMetaData: required: - jobExecution_Attribute - jobExecution_Key type: object properties: jobExecution_Key: type: integer description: 'Key value identifying an instance of the execution of the job Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 jobExecution_Attribute: maxLength: 64 minLength: 1 type: string description: Attribute or parameter used by the job during execution entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true jobExecution_Attribute_Value: type: string description: Value of the attribute or parameter used by the job during execution nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false JobExecutionMetaDataListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/JobExecutionMetaData' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false JobExecutionMetaDataVBAResponse: type: object properties: data: $ref: '#/components/schemas/JobExecutionMetaData' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false JobExecutionVBAResponse: type: object properties: data: $ref: '#/components/schemas/JobExecution' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false JobListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Job' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false JobType: required: - job_Type type: object properties: job_Type: maxLength: 32 minLength: 1 type: string description: Identifier for the type of job description: maxLength: 512 type: string description: Description for the type of job nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false JobTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/JobType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false JobTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/JobType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false JobVBAResponse: type: object properties: data: $ref: '#/components/schemas/Job' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false JsonNode: type: object properties: options: $ref: '#/components/schemas/JsonNodeOptions' parent: $ref: '#/components/schemas/JsonNode' root: $ref: '#/components/schemas/JsonNode' additionalProperties: false JsonNodeOptions: type: object properties: hasValue: type: boolean readOnly: true value: $ref: '#/components/schemas/JsonNodeOptions' additionalProperties: false JsonValue: type: object properties: options: $ref: '#/components/schemas/JsonNodeOptions' parent: $ref: '#/components/schemas/JsonNode' root: $ref: '#/components/schemas/JsonNode' additionalProperties: false KeyValuePair: type: object properties: key: type: string nullable: true value: type: string nullable: true additionalProperties: false Languages: required: - language_ID type: object properties: language_ID: maxLength: 8 minLength: 1 type: string description: Identifier for the language description: maxLength: 500 type: string description: Description string for the language used in reports nullable: true display: maxLength: 200 type: string description: Display string for the language used in lists nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false LanguagesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Languages' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false LanguagesVBAResponse: type: object properties: data: $ref: '#/components/schemas/Languages' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false LifeClaimAdvisor: type: object properties: subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true plan_ID: type: string nullable: true volume: type: number format: double nullable: true claimNumber: type: string nullable: true deathDate: type: string format: date-time nullable: true lastDayWorked: type: string format: date-time nullable: true causeOfDeath: type: integer format: int32 nullable: true illness: type: integer format: int32 nullable: true illnessDuration: type: integer format: int32 nullable: true illnessDurationType: type: string nullable: true attendingProviderID: type: string nullable: true attendingFirstName: type: string nullable: true attendingLastName: type: string nullable: true attendingOrgName: type: string nullable: true attendingAddress: type: string nullable: true attendingAddress2: type: string nullable: true attendingCity: type: string nullable: true attendingState: type: string nullable: true attendingZipCode: type: string nullable: true attendingEntityID: type: string nullable: true diagType: type: string nullable: true diag1: type: string nullable: true diag2: type: string nullable: true diag3: type: string nullable: true diag4: type: string nullable: true payTo: type: string nullable: true mailTo: type: string nullable: true exCode1: type: string nullable: true exCode2: type: string nullable: true place: type: string nullable: true receivedDate: type: string format: date-time nullable: true procedureCode: type: string nullable: true createPayment: type: boolean customFields: type: array items: $ref: '#/components/schemas/IDCodeValue' nullable: true beneficiaries: type: array items: $ref: '#/components/schemas/MemberBeneficiary' nullable: true lifeBenefits: type: array items: $ref: '#/components/schemas/ClaimBatchLifeBenefit' nullable: true documents: type: array items: $ref: '#/components/schemas/Note_NoteAttachment' nullable: true additionalProperties: false LocalTax: required: - local_Tax_Code type: object properties: local_Tax_Code: maxLength: 128 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false LocalTaxListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/LocalTax' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false LocalTaxVBAResponse: type: object properties: data: $ref: '#/components/schemas/LocalTax' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false LogType: required: - name type: object properties: name: maxLength: 32 minLength: 1 type: string description: maxLength: 256 type: string nullable: true additionalProperties: false LogTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/LogType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false LogTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/LogType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MFADeviceSetupRequest: type: object properties: accessToken: type: string description: A valid access token issued to the user whose MFA Device you want to set-up. nullable: true additionalProperties: false MFADeviceSetupResponse: type: object properties: qrCode: type: string description: A Base64-encoded string representing the QR code image generated from the secret code. Can be used for setting up multi-factor authentication with an authenticator app. nullable: true secretCode: type: string description: A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code. nullable: true additionalProperties: false MFADeviceSetupResponseVBAResponse: type: object properties: data: $ref: '#/components/schemas/MFADeviceSetupResponse' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MaritalStatus: required: - marital_Status type: object properties: marital_Status: maxLength: 1 minLength: 1 type: string description: Identifier for the marital status description: maxLength: 32 type: string description: Description of the marital status nullable: true additionalProperties: false MaritalStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MaritalStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MaritalStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/MaritalStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemEnrollmentPlan: required: - division_ID - group_Coverage_Start - group_ID - member_Seq - plan_ID - plan_Start - sub_Start_Date - subscriber_ID - use_Volume_Scale type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References the Subenrollment.Subscriber_ID value in the parent table. member_Seq: maxLength: 2 minLength: 1 type: string description: References the Members.Member_Seq for this members enrollment. group_ID: maxLength: 20 minLength: 1 type: string description: References the Subenrollment.Group_ID value in the parent table. division_ID: maxLength: 20 minLength: 1 type: string description: References the Subenrollment.Division_ID value in the parent table. group_Coverage_Start: type: string description: References the Subenrollment.Group_Coverage_Start value in the parent table. format: date-time sub_Start_Date: type: string description: References the Subenrollment.Start_Date value in the parent table. format: date-time plan_ID: maxLength: 20 minLength: 1 type: string description: References the GroupContractPlan.Plan_ID value indicating which Plan this member is enrolling that is being offered. plan_Start: type: string description: Start date of the Plan coverage. format: date-time dollar_Amount: type: number description: The Member's 'Volume' within the selected plan on the enrollment. The Member Enrollment 'Volume' has no impact on invoicing. format: double nullable: true entry_Date: type: string description: Date when the record was first added. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record. nullable: true ltC_Daily_Benefit_Amount: type: number description: Member elected Daily Benefit Amount format: double nullable: true ltC_Lifetime_Max_Amount: type: number description: Lifetime Max Amount elected format: double nullable: true ltC_Lifetime_Max_Days: type: integer description: Lifetime Max Days elected format: int32 nullable: true ltC_Lifetime_Max_Years: type: integer description: Lifetime Max Years elected format: int32 nullable: true ltC_Monthly_Benefit_Amount: type: number description: Member elected Monthly Benefit Amount format: double nullable: true plan_End: type: string description: End date of the Plan coverage. format: date-time nullable: true tier: maxLength: 2 type: string description: The Member's 'Tier' within the selected plan on the enrollment. The Member Enrollment 'Tier' has no impact on adjudication or invoicing. nullable: true update_Date: type: string description: Date when the record was last updated. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record. nullable: true use_Volume_Scale: type: boolean description: 'Indicates if this enrollment plan record should calculate the Dollar_Amount value through the Group leve Volume settings rather than use the value stored in Dollar_Amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' additionalProperties: false MemEnrollmentPlanListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemEnrollmentPlan' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemEnrollmentPlanVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemEnrollmentPlan' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemEnrollmentRider: required: - benefit_Code - division_ID - employee_Contribution_Pct - from_Date - group_Coverage_Start - group_ID - member_Seq - plan_ID - plan_Start - sub_Start_Date - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References the MemenrollmentPlan.Subscriber_ID value in parent table. member_Seq: maxLength: 2 minLength: 1 type: string description: References the MemenrollmentPlan.Member_Seq value in parent table. group_ID: maxLength: 20 minLength: 1 type: string description: References the MemenrollmentPlan.Group_ID value in parent table. division_ID: maxLength: 20 minLength: 1 type: string description: References the MemenrollmentPlan.Division_ID value in parent table. group_Coverage_Start: type: string description: References the MemenrollmentPlan.Group_Coverage_Start value in parent table. format: date-time sub_Start_Date: type: string description: References the MemenrollmentPlan.Sub_Start_Date value in parent table. format: date-time plan_ID: maxLength: 20 minLength: 1 type: string description: References the MemenrollmentPlan.Plan_ID value in parent table. plan_Start: type: string description: References the MemenrollmentPlan.Plan_Start value in parent table. format: date-time benefit_Code: maxLength: 10 minLength: 1 type: string description: References the BenefitCodes.Benefit_Code value that is flagged as a Rider on this Plan and indicates the optional coverage this member has enrolled in. from_Date: type: string description: Start date of Rider coverage. format: date-time employee_Contribution: type: number description: Indicates the Employee Contribution amount that is used during Diability processing to properly take tax amounts. format: double nullable: true employee_Contribution_Pct: type: boolean description: 'Indicates if the Emploee Contribution amount entered is a Pct or flat amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true external_ID: maxLength: 64 type: string description: Custom value used for Ceridican tax processing interface. nullable: true ltC_Daily_Benefit_Amount: type: number description: Member elected Daily Benefit Amount format: double nullable: true ltC_Lifetime_Max_Amount: type: number description: Lifetime Max Amount elected format: double nullable: true ltC_Lifetime_Max_Days: type: integer description: Lifetime Max Days elected format: int32 nullable: true ltC_Lifetime_Max_Years: type: integer description: Lifetime Max Years elected format: int32 nullable: true ltC_Monthly_Benefit_Amount: type: number description: Member elected Monthly Benefit Amount format: double nullable: true thru_Date: type: string description: End date of Rider coverage. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true volume: type: number description: The Member's 'Volume' within the selected Rider benefit on the enrollment. The Member Enrollment 'Volume' has no impact on invoicing. format: double nullable: true additionalProperties: false MemEnrollmentRiderListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemEnrollmentRider' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemEnrollmentRiderVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemEnrollmentRider' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberAccount: required: - memberAccount_Key - preNote_Sent - wire_Transfer type: object properties: memberAccount_Key: type: integer description: 'Unique identifier for each Account on this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 account_Key: type: integer description: References FundingAccount.Account_Key for this account on this Member. format: int32 nullable: true effective_From: type: string description: Date when the Member account becomes/became effective. format: date-time nullable: true effective_Thru: type: string description: Date when the Member account becomes/became terminated. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true member_Seq: maxLength: 2 type: string description: References Members.Member_Seq value on the parent record. nullable: true preNote_Sent: type: boolean description: 'Custom value used for accounting system integrations. Note: This field is marked as NOT NULL in the database and therefore required by the API.' preNote_SentDate: type: string description: Custom value used for accounting system integrations. format: date-time nullable: true subscriber_ID: maxLength: 9 type: string description: References Members.Subscriber_ID value on the parent record. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true wire_Transfer: type: boolean description: 'Indicates that the Member account is setup for direct deposit. Checking this box will activate the ACH option within Subscriber Information. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false MemberAccountListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberAccount' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberAccountPlan: required: - memberAccount_Key - plan_ID type: object properties: memberAccount_Key: type: integer description: 'Unique identifier for each Plan and Account combination for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 plan_ID: maxLength: 20 minLength: 1 type: string description: References the SubenrollmentPlan.Plan_ID value for this members enrollment. benefit_Amount: type: number description: Total Benefit amount associated with the Member's plan. format: double nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberAccountPlanListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberAccountPlan' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberAccountPlanPayment: required: - memberAccount_Key - payment_Key - plan_ID type: object properties: payment_Key: type: integer description: 'Unique identifier for each payment record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true memberAccount_Key: type: integer description: 'References the MemberAccount.MemberAccount_Key value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 plan_ID: maxLength: 20 minLength: 1 type: string description: References the SubenrollmentPlan.Plan_ID value for this members enrollment. transaction_Amount: type: number description: Total amount of the transaction. format: double nullable: true transaction_Date: type: string description: Date when the transaction occurred. format: date-time nullable: true transaction_ID: maxLength: 20 type: string description: Identifier assigned to the associated transaction. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberAccountPlanPaymentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberAccountPlanPayment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberAccountPlanPaymentVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberAccountPlanPayment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberAccountPlanVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberAccountPlan' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberAccountVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberAccount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberAccum: required: - allowed_Amt - allowed_Amt_Net - allowed_Amt_OON - benefit_Code - benefit_Used - benefit_Used_Net - benefit_Used_OON - billed_Amt - billed_Amt_Net - billed_Amt_OON - coB_Amt - coB_Amt_Net - coB_Amt_OON - coins_Amt - coins_Amt_Net - coins_Amt_OON - copay_Amt - copay_Amt_Net - copay_Amt_OON - ded_Credit_OON_Used - ded_Credit_PPO_Used - ded_Credit_Used - ded_PPO_Used - deductible_Used - deductible_Used_OON - group_ID - member_Seq - not_Covered_Amt - not_Covered_Amt_Net - not_Covered_Amt_OON - out_Of_Pocket - out_Of_Pocket_Net - out_Of_Pocket_OON - plan_Type - plan_Year - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. group_ID: maxLength: 20 minLength: 1 type: string description: References the Subenrollment.Group_ID value in the parent table. plan_Year: maxLength: 8 minLength: 1 type: string description: References the GroupPlanYear.Plan_Year value in the parent table. plan_Type: maxLength: 6 minLength: 1 type: string description: Plan Type tied to this Accumulator. benefit_Code: maxLength: 10 minLength: 1 type: string description: Benefit code associated with the Member Accumulator. added_Accum: maxLength: 1 type: string description: Selecting this option indicates that the Accumulator is an Added Accumulator. nullable: true allowed_Amt: type: number description: 'Total Allowed amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double allowed_Amt_Net: type: number description: 'Allowed amount that has been used In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double allowed_Amt_OON: type: number description: 'Allowed amount that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double benefit_Used: type: number description: 'Total amount of benefit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double benefit_Used_Net: type: number description: 'In network amount of benefit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double benefit_Used_OON: type: number description: 'Amount of benefit that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double billed_Amt: type: number description: 'Amount that has been billed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double billed_Amt_Net: type: number description: 'Amount that has been billed In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double billed_Amt_OON: type: number description: 'Amount that has been billed Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coB_Amt: type: number description: 'Total Coordination of Benefits amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coB_Amt_Net: type: number description: 'In Network Coordination of Benefits amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coB_Amt_OON: type: number description: 'Coordination of Benefits amount that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coins_Amt: type: number description: 'Total amount of Coinsurance that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coins_Amt_Net: type: number description: 'In Network amount of Coinsurance that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coins_Amt_OON: type: number description: 'Amount of Coinsurance that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double copay_Amt: type: number description: 'Total amount of Copay that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double copay_Amt_Net: type: number description: 'In Network amount of Copay that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double copay_Amt_OON: type: number description: 'Amount of Copay that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double ded_Credit_OON_Used: type: number description: 'Amount of deductible credit that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double ded_Credit_PPO_Used: type: number description: 'In Network amount of deductible credit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double ded_Credit_Used: type: number description: 'Total amount of deductible credit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double ded_PPO_Used: type: number description: 'In Network amount of deductible that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double deductible_Used: type: number description: 'Total amount of deductible that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double deductible_Used_OON: type: number description: 'Amount of deductible that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true not_Covered_Amt: type: number description: 'Total amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double not_Covered_Amt_Net: type: number description: 'In Network amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double not_Covered_Amt_OON: type: number description: 'Out of Network amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double out_Of_Pocket: type: number description: 'Total Out of Pocket amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double out_Of_Pocket_Net: type: number description: 'Amount of Out of Pocket that has been used In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double out_Of_Pocket_OON: type: number description: 'Amount of Out of Pocket that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberAccumListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberAccum' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberAccumVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberAccum' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberAddress: required: - member_Seq - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. address: maxLength: 128 type: string description: Primary address of the Member. nullable: true address2: maxLength: 128 type: string description: Address line 2 of the Member's primary address. nullable: true cell_Country_Code: maxLength: 8 type: string description: Country code of the Member's cell phone number. nullable: true cell_Phone: maxLength: 32 type: string description: Cell phone number of the Member. nullable: true city: maxLength: 32 type: string description: City of the Member's primary address. nullable: true country_ID: maxLength: 8 type: string description: Identifier of the country of the Member's primary address. nullable: true county_Code: maxLength: 8 type: string description: County code of the Member's primary address. nullable: true effective_Date: type: string description: Date when the Member Address becomes/became effective. format: date-time nullable: true email_Address: maxLength: 128 type: string description: Email address of the Member. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true home_Country_Code: maxLength: 8 type: string description: Country code of the Member's home phone number. nullable: true home_Phone: maxLength: 32 type: string description: Home phone number of the Member. nullable: true latitude: maxLength: 12 type: string description: Latitudinal coordinate of the Member's primary address. nullable: true longitude: maxLength: 13 type: string description: Longitudinal coordinate of the Member's primary address. nullable: true region_Code: maxLength: 32 type: string description: Region code of the Member's primary address. nullable: true secondary_Address: maxLength: 128 type: string description: Secondary address associated with the Member. nullable: true secondary_Address2: maxLength: 256 type: string description: Line 2 of secondary address associated with the Member. nullable: true secondary_City: maxLength: 32 type: string description: City of the Member's secondary address. nullable: true secondary_County_Code: maxLength: 8 type: string description: County code of the Secondary Address nullable: true secondary_State: maxLength: 2 type: string description: State of the Member's secondary address. nullable: true secondary_Zip_Code: maxLength: 10 type: string description: Zip code of the Member's secondary address. nullable: true state: maxLength: 2 type: string description: State of the Member's primary address. nullable: true term_Date: type: string description: Date when the Member Address is no longer valid/effective. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true work_Country_Code: maxLength: 8 type: string description: Country code of the Member's work phone number. nullable: true work_Phone: maxLength: 32 type: string description: Work phone number of the Member. nullable: true zip_Code: maxLength: 32 type: string description: Zip code of the Member's primary address. nullable: true additionalProperties: false MemberAddressHistory: required: - member_Seq - memberAddressHistory_Key - subscriber_ID type: object properties: memberAddressHistory_Key: type: integer description: 'ID of the Member Address History record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 address: maxLength: 128 type: string description: Primary address of the Member. nullable: true address2: maxLength: 128 type: string description: Address line 2 of the Member's primary address. nullable: true cell_Country_Code: maxLength: 8 type: string description: Country code of the Member's cell phone number. nullable: true cell_Phone: maxLength: 32 type: string description: Cell phone number of the Member. nullable: true city: maxLength: 32 type: string description: City of the Member's primary address. nullable: true country_ID: maxLength: 8 type: string description: Identifier of the country of the Member's primary address. nullable: true county_Code: maxLength: 8 type: string description: County code of the Member's primary address. nullable: true effective_Date: type: string description: Date when the Member Address becomes/became effective. format: date-time nullable: true email_Address: maxLength: 128 type: string description: Email address of the Member. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true home_Country_Code: maxLength: 8 type: string description: Country code of the Member's home phone number. nullable: true home_Phone: maxLength: 32 type: string description: Home phone number of the Member. nullable: true latitude: maxLength: 12 type: string description: Latitudinal coordinate of the Member's primary address. nullable: true longitude: maxLength: 13 type: string description: Longitudinal coordinate of the Member's primary address. nullable: true member_Seq: maxLength: 2 minLength: 1 type: string description: Sequential identifier assigned to the Member. region_Code: maxLength: 32 type: string description: Region code of the Member's primary address. nullable: true secondary_Address: maxLength: 128 type: string description: Secondary address associated with the Member. nullable: true secondary_Address2: maxLength: 256 type: string description: Line 2 of secondary address associated with the Member. nullable: true secondary_City: maxLength: 32 type: string description: City of the Member's secondary address. nullable: true secondary_County_Code: maxLength: 8 type: string description: County code of the Secondary Address nullable: true secondary_State: maxLength: 2 type: string description: State of the Member's secondary address. nullable: true secondary_Zip_Code: maxLength: 10 type: string description: Zip code of the Member's secondary address. nullable: true state: maxLength: 2 type: string description: State of the Member's primary address. nullable: true subscriber_ID: maxLength: 9 minLength: 1 type: string description: Identifier assigned to the Subscriber associated with this Member. term_Date: type: string description: Date when the Member Address is no longer valid/effective. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true work_Country_Code: maxLength: 8 type: string description: Country code of the Member's home phone number. nullable: true work_Phone: maxLength: 32 type: string description: Work phone number of the Member. nullable: true zip_Code: maxLength: 32 type: string description: Zip code of the Member's primary address. nullable: true additionalProperties: false MemberAddressHistoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberAddressHistory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberAddressHistoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberAddressHistory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberAddressVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberAddress' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberBeneficiary: required: - beneficiary_ID - exclude_Interest - member_Seq - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. beneficiary_ID: maxLength: 20 minLength: 1 type: string description: Unique identifier for this beneficiary on this member. address: maxLength: 512 type: string description: Primary address of the Beneficiary. nullable: true address2: maxLength: 128 type: string description: Address line 2 of the Beneficiary's primary address. nullable: true assignment: type: number description: A set amount paid to a beneficiary. format: double nullable: true city: maxLength: 32 type: string description: City of the Beneficiary's primary address. nullable: true country_ID: maxLength: 8 type: string description: Identifier of the country of the Beneficiary's primary address. nullable: true date_Of_Birth: type: string description: Date of birth of the Beneficiary. format: date-time nullable: true end_Date: type: string description: End date of the Beneficiary's status. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exclude_Interest: type: boolean description: 'Indicates if interest should be excluded when adjudicating Life claims paid to this beneficiary. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' first_Name: maxLength: 25 type: string description: First name of the Beneficiary. nullable: true last_Name: maxLength: 25 type: string description: Last name of the Beneficiary. nullable: true long_Name: maxLength: 512 type: string description: Full name of the Beneficiary. nullable: true middle_Name: maxLength: 25 type: string description: Middle name of the Beneficiary. nullable: true percentage: type: number description: Percentage of the benefit that is allotted to the associated Beneficiary. format: double nullable: true primary_Beneficiary: type: boolean description: Indicates whether the associated Beneficiary is the primary Beneficiary. nullable: true relationship: maxLength: 12 type: string description: Relationship of the Beneficiary to the Member. nullable: true ssn: maxLength: 32 type: string description: Social security number of the Beneficiary. nullable: true secondary_Beneficiary: type: boolean description: This flag indicates if this beneficiary is secondary. nullable: true start_Date: type: string description: Start date of the Beneficiary's status. format: date-time nullable: true state: maxLength: 2 type: string description: State of the Beneficiary's primary address. nullable: true tertiary_Beneficiary: type: boolean description: This flag indicates if this tertiary is secondary. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true zip: maxLength: 32 type: string description: Zip code of the Beneficiary's primary address. nullable: true additionalProperties: false MemberBeneficiaryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberBeneficiary' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberBeneficiaryPlan: required: - beneficiary_ID - member_Seq - plan_ID - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References MemberBeneficiary.Subscriber_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References MemberBeneficiary.Member_Seq value on the parent record. beneficiary_ID: maxLength: 20 minLength: 1 type: string description: References MemberBeneficiary.Beneficiary_ID value on the parent record. plan_ID: maxLength: 20 minLength: 1 type: string description: References Plans.Plan_ID value on parent record. entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false MemberBeneficiaryPlanListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberBeneficiaryPlan' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberBeneficiaryPlanVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberBeneficiaryPlan' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberBeneficiaryVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberBeneficiary' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberCOBSavings: required: - group_ID - member_Seq - memberCOBSavings_Key - plan_Type - plan_Year - subscriber_ID type: object properties: memberCOBSavings_Key: type: integer description: 'Unique identifier for each COB Savings record for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 coB_Savings: type: number description: 'Allows the User to override the automated COB Savings amount. If the ‘Use COB Savings’ option is selected within ‘Plan Options’, COB Savings auto-populate based upon the ‘COB’ amount.' format: double nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: Group associated with the COB savings override. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. plan_Type: maxLength: 6 minLength: 1 type: string description: Identifies the plan type that the COB savings override will be applied to. plan_Year: maxLength: 8 minLength: 1 type: string description: Identifies the plan year that the COB savings override will be applied to. subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberCOBSavingsListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberCOBSavings' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberCOBSavingsVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberCOBSavings' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberCareAlert: required: - member_Seq - memberCareAlert_Key - subscriber_ID type: object properties: memberCareAlert_Key: type: integer description: 'Unique identifier for each Member Care Alert record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 alert_Details: maxLength: 1024 type: string description: A description area used to provide more detail about the care alert. nullable: true care_Alert_Status: maxLength: 32 type: string description: 'Status of the care alert that will be sent to the Member based upon the alert criteria. The status can be set to either ''Due Soon'', ''Past Due'', or ''Completed''.' nullable: true diagnostic_Code: maxLength: 8 type: string description: Diagnostic code tied to the care alert. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true frequency: type: integer description: Identifies the frequency of the care alert by specifying the number of the associated frequency type that should be used. format: int32 nullable: true frequency_Type: maxLength: 16 type: string description: 'Identifies the frequency at which the care alerts should be sent. This can be based upon a certain number of months, an annual basis, or a certain number of years.' nullable: true last_Service_Date: type: string description: Identifies the last date that the Member received the service associated with the care alert. format: date-time nullable: true member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. next_Service_Date: type: string description: Idenfities the next date that the Member is to receive the service associated with the care alert. format: date-time nullable: true procedure_Code: maxLength: 8 type: string description: Procedure code tied the care alert. nullable: true subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberCareAlertListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberCareAlert' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberCareAlertVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberCareAlert' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberCaseHead: required: - member_Seq - memberCaseHead_Key - subscriber_ID type: object properties: memberCaseHead_Key: type: integer description: 'Unique identifier associated with this Case Head entry for this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 caseHead_Key: type: integer description: References CaseHead.CaseHead_Key on parent record. format: int32 nullable: true effective_Date: type: string description: Date when the case head becomes/became effective. format: date-time nullable: true end_Date: type: string description: Date when the case head becomes/became terminated. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberCaseHeadListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberCaseHead' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberCaseHeadVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberCaseHead' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberClass: required: - class_Code - member_Seq - memberClass_Key - subscriber_ID type: object properties: memberClass_Key: type: integer description: 'Unique identifier for each Class entry for this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 class_Code: maxLength: 32 minLength: 1 type: string description: List of 'classes' that can be associated with a Member. This can be configured within Enrollment Services > Enrollment Configuration > Classes. effective_Date: type: string description: Date when the 'class' becomes/became effective. format: date-time nullable: true entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. term_Date: type: string description: Date when the 'class' becomes/became terminated. format: date-time nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false MemberClassListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberClass' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberClassVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberClass' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberCollege: required: - member_Seq - memberCollege_Key - subscriber_ID type: object properties: memberCollege_Key: type: integer description: 'Unique identifier for each college record for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 college_Key: type: integer description: Identifier associated with the Member's school. This can be configured within System Services > System Configuration > Colleges. format: int32 nullable: true contact_Fax: maxLength: 32 type: string description: Fax number of the Contact associated with the Member's school. nullable: true contact_Name: maxLength: 128 type: string description: Name of the Contact associated with the Member's school. nullable: true contact_Phone: maxLength: 32 type: string description: Phone number of the Contact associated with the Member's school. nullable: true effective_Date: type: string description: Date when the Member's 'student' status becomes/became effective. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true hours: type: number description: Identifies how many hours the Member is currently enrolled in. format: double nullable: true member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. semester: type: integer description: Identifies the semester that the Member is currently enrolled in. format: int32 nullable: true subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. term_Date: type: string description: Date when the Member's 'student' status expires/expired. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberCollegeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberCollege' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberCollegeVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberCollege' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberEligibilityStatus: required: - eligibility_Status - member_Seq - memberEligibilityStatus_Key - subscriber_ID type: object properties: memberEligibilityStatus_Key: type: integer description: 'Unique identifier for each Eligiblity Status value for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 effective_Date: type: string description: Date when the eligibility status becomes/became effective. format: date-time nullable: true eligibility_Status: maxLength: 8 minLength: 1 type: string description: Identifies the eligibility status to be tied to the Member. This can be configured within Enrollment Services > Enrollment Configuration > Eligibility Status. end_Date: type: string description: Date when the eligibility status expires/expired. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberEligibilityStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberEligibilityStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberEligibilityStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberEligibilityStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberIDCardPrinted: required: - member_Seq - printed_Date - reportDefinition_Key - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. reportDefinition_Key: type: integer description: 'References ReportDefinition.ReportDefinition_Key for this report. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 printed_Date: type: string description: 'Date when the ID Card was printed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberIDCardPrintedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberIDCardPrinted' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberIDCardPrintedVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberIDCardPrinted' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberInsurance: required: - member_Seq - priority - seq_Number - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. seq_Number: type: integer description: 'Unique sequence value for each Insurance record for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 carrier_Key: type: integer description: Identifies the 'Other Insurance' Carrier. format: int32 nullable: true carrier_Name: maxLength: 64 type: string description: Carrier name for this other insurance record. nullable: true coverageType: maxLength: 20 type: string description: Coverage Type of 'Other Insurance' policy. nullable: true end_Date: type: string description: Date when the 'Other Insurance' expires/expired. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true group_Number: maxLength: 20 type: string description: Group number of 'Other Insurance' policy. nullable: true insurance_Type: type: integer description: Insurance type of the 'Other Insurance' policy. format: int32 nullable: true limits: type: number description: Dollar amount of the 'Other Insurance' policy. format: double nullable: true plan_Type: maxLength: 6 type: string description: Plan type associated with the 'Other Insurance'. nullable: true policyHolderName: maxLength: 40 type: string description: Name of the 'Other Insurance' primary policy holder. nullable: true policy_Number: maxLength: 32 type: string description: Number of the 'Other Insurance' policy. nullable: true priority: type: integer description: 'Priority of the Member''s ''Other Insurance''. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 secondary_Member_Seq: maxLength: 2 type: string description: 'For purposes of utlizing Auto-COB processing, this indicates the member who is covered by Secondary Insurance under this Insured record.' nullable: true secondary_Subscriber_ID: maxLength: 9 type: string description: 'For purposes of utlizing Auto-COB processing, this indicates the member who is covered by Secondary Insurance under this Insured record.' nullable: true start_Date: type: string description: Date when the 'Other Insurance' becomes/became effective. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberInsuranceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberInsurance' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberInsuranceVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberInsurance' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberLanguage: required: - language_ID - member_Seq - primary_Language - secondary_Language - spoken_Language - subscriber_ID - written_Language type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. language_ID: maxLength: 8 minLength: 1 type: string description: References Languages.Language_ID value on the referenced record. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true primary_Language: type: boolean description: 'Idenfities that the associated language is the Member''s primary language. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' secondary_Language: type: boolean description: 'Identifies that the associated language is the Member''s secondary language. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' spoken_Language: type: boolean description: 'A flag indicating a Member can speak the language. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true written_Language: type: boolean description: 'A flag indicating a Member can write the language. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' additionalProperties: false MemberLanguageListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberLanguage' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberLanguageVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberLanguage' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberMedicareResp: required: - disposition_Code_Date - ersD_Coord_Period_End_Date - ersD_Coord_Period_Start_Date - esrD_Self_Training_Date - first_Dialysis_Date - medicare_Part_A_Eff_Date - medicare_Part_A_Term_Date - medicare_Part_A_Update_Date - medicare_Part_B_Eff_Date - medicare_Part_B_Term_Date - medicare_Part_B_Update_Date - medicare_Part_C_Eff_Date - medicare_Part_C_Term_Date - medicare_Part_C_Update_Date - medicare_Part_D_Eff_Date - medicare_Part_D_Term_Date - medicare_Part_D_Update_Date - msP_Birth_Date - msP_Eff_Date - msP_Term_Date - transplant_Date_Most_Recent - transplant_Failure_Date_Most_Recent type: object properties: memberMedicareResp_Key: type: integer description: 'Unique identifier for each Medicare Reponsibility record on this Member. Note: The database will apply a default value of ''0'' for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of ''0'' to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 cobC_Assigned_DCN: maxLength: 16 type: string description: Indicates the coordination of benefits contractor's document control number. nullable: true compliance_Flag1: maxLength: 2 type: string description: Compliance Code 1. nullable: true compliance_Flag10: maxLength: 2 type: string description: Compliance Code 10. nullable: true compliance_Flag2: maxLength: 2 type: string description: Compliance Code 2. nullable: true compliance_Flag3: maxLength: 2 type: string description: Compliance Code 3. nullable: true compliance_Flag4: maxLength: 2 type: string description: Compliance Code 4. nullable: true compliance_Flag5: maxLength: 2 type: string description: Compliance Code 5. nullable: true compliance_Flag6: maxLength: 2 type: string description: Compliance Code 6. nullable: true compliance_Flag7: maxLength: 2 type: string description: Compliance Code 7. nullable: true compliance_Flag8: maxLength: 2 type: string description: Compliance Code 8. nullable: true compliance_Flag9: maxLength: 2 type: string description: Compliance Code 9. nullable: true disposition_Code: maxLength: 8 type: string description: Disposition code that indicates the results of processing. nullable: true disposition_Code_Date: type: string description: Date associated with the disposition code. format: date-time ersD_Coord_Period_End_Date: type: string description: End date of the coordination period for the Member's End State Renal Disease. format: date-time ersD_Coord_Period_Start_Date: type: string description: Start date of the coordination period for the Member's End Stage Renal Disease. format: date-time esrD_Self_Training_Date: type: string description: Date when the Member started self-training. format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true error_Code1: maxLength: 8 type: string description: Error Code 1. nullable: true error_Code2: maxLength: 8 type: string description: Error Code 2. nullable: true error_Code3: maxLength: 8 type: string description: Error Code 3. nullable: true error_Code4: maxLength: 8 type: string description: Error Code 4. nullable: true first_Dialysis_Date: type: string description: Date when the Member first underwent dialysis. format: date-time hicn: maxLength: 16 type: string description: Indicates the Medicare health insurance claim number. nullable: true late_Submission_Ind: maxLength: 1 type: string description: Indicates that the Medicare Sec. 111 submission was late. nullable: true msP_Birth_Date: type: string description: Date of birth of the Medicare Secondary Payor. format: date-time msP_Eff_Date: type: string description: Date when the Medicare Secondary Payor becomes/became effective. format: date-time msP_Gender: maxLength: 1 type: string description: Gender of the Medicare Secondary Payor. nullable: true msP_Last_Name: maxLength: 25 type: string description: Medicare Secondary Payor's last name. nullable: true msP_Term_Date: type: string description: Date when the Medicare Secondary Payor expires/expired. format: date-time medicare_Part_A_Eff_Date: type: string description: Date when this Medicare part becomes/became effective. format: date-time medicare_Part_A_Term_Date: type: string description: Date when this Medicare part expires/expired. format: date-time medicare_Part_A_Update_Date: type: string description: Date when this Medicare part was last updated. format: date-time medicare_Part_B_Eff_Date: type: string description: Date when this Medicare part becomes/became effective. format: date-time medicare_Part_B_Term_Date: type: string description: Date when this Medicare part expires/expired. format: date-time medicare_Part_B_Update_Date: type: string description: Date when this Medicare part was last updated. format: date-time medicare_Part_C_Control_Num: maxLength: 5 type: string description: Indicates the control number for the associated Medicare part. nullable: true medicare_Part_C_Eff_Date: type: string description: Date when this Medicare part becomes/became effective. format: date-time medicare_Part_C_Term_Date: type: string description: Date when this Medicare part expires/expired. format: date-time medicare_Part_C_Update_Date: type: string description: Date when this Medicare part was last updated. format: date-time medicare_Part_D_Control_Num: maxLength: 5 type: string description: Indicates the control number for the associated Medicare part. nullable: true medicare_Part_D_Eff_Date: type: string description: Date when this Medicare part becomes/became effective. format: date-time medicare_Part_D_Term_Date: type: string description: Date when this Medicare part expires/expired. format: date-time medicare_Part_D_Update_Date: type: string description: Date when this Medicare part was last updated. format: date-time member_Seq: maxLength: 2 type: string description: References Members.Member_Seq value on the parent record. nullable: true rrE_Assigned_DCN: maxLength: 16 type: string description: Indicates the responsiible reporting entity's assigned document control number. nullable: true submission_Status: maxLength: 8 type: string description: Status of the Medicare Sec. 111 reporting. nullable: true subscriber_ID: maxLength: 9 type: string description: References Members.Subscriber_ID value on the parent record. nullable: true transplant_Date_Most_Recent: type: string description: Date of the Member's most recent transplant. format: date-time transplant_Failure_Date_Most_Recent: type: string description: Date of the Member's most recent transplant failure. format: date-time update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberMedicareRespListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberMedicareResp' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberMedicareRespVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberMedicareResp' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberNetwork: required: - division_ID - effective_Date - group_ID - member_Seq - network_ID - subscriber_ID type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: References GroupNetwork.Group_ID in parent table. division_ID: maxLength: 20 minLength: 1 type: string description: References GroupNetwork.Division_ID in parent table. subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. network_ID: maxLength: 10 minLength: 1 type: string description: References GroupNetwork.Network_ID in parent table. effective_Date: type: string description: 'Date when the Network becomes/became effective for the Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true network_Type: maxLength: 16 type: string description: Identifies the type associated with the selected Network. nullable: true term_Date: type: string description: Date when the Network expires/expired for the Member. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberNetworkListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberNetwork' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberNetworkVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberNetwork' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberOccupation: required: - effective_Date - member_Seq - occupation_ID - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. occupation_ID: maxLength: 32 minLength: 1 type: string description: Identifies the occupation that is associated with the Member. effective_Date: type: string description: 'Date when the occupation becomes/became effective for the Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true hire_Date: type: string description: Date when the Member was hired at the associated occupation. format: date-time nullable: true pay_Rate: type: number description: Rate of pay for the Member at the associated occupation. format: double nullable: true pay_Rate_Frequency: maxLength: 16 type: string description: Frequency of the rate of pay for the Member at the associated occupation. nullable: true term_Date: type: string description: Date when the occupation expires/expired for the Member. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberOccupationListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberOccupation' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberOccupationVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberOccupation' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberPayment: required: - division_ID - group_Coverage_Start - group_ID - member_Seq - memberPayment_Key - start_Date - subscriber_ID type: object properties: memberPayment_Key: type: integer description: 'Unique Identifier for this payment for the member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 division_ID: maxLength: 20 minLength: 1 type: string description: References Subenrollment.Division_ID value on the parent record. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true group_Coverage_Start: type: string description: 'References Subenrollment.Group_Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time group_ID: maxLength: 20 minLength: 1 type: string description: References Subenrollment.Group_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. payment_Amount: type: number description: Amount of the associated payment. format: double nullable: true payment_Date: type: string description: Date when the associated payment was processed. format: date-time nullable: true payment_ID: maxLength: 20 type: string description: Unique identifier assigned to the associated payment. nullable: true payment_Type: maxLength: 32 type: string description: Identifies the type associated with the payment. nullable: true start_Date: type: string description: 'References Subenrollment.Start_Date value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberPaymentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberPayment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberPaymentVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberPayment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberPlanYear: required: - member_Seq - memberPlanYear_Key - plan_Year - plan_Year_End - plan_Year_Start - seq - subscriber_ID - year type: object properties: memberPlanYear_Key: type: integer description: Unique identifier for each custom plany year for this member. format: int32 member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. plan_Year: maxLength: 8 minLength: 1 type: string description: Specifies the plan year associated with the selected Plan. plan_Year_End: type: string description: Date when the plan year ends/ended. format: date-time plan_Year_Start: type: string description: Date when the plan year starts/started. format: date-time seq: type: integer description: Sequence assigned to this Plan Year record within this configuration. format: int32 subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. year: maxLength: 4 minLength: 1 type: string description: The calendar year associated with this Plan Year (used in instances where the plan year is not a calendar year). additionalProperties: false MemberPlanYearListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberPlanYear' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberPlanYearVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberPlanYear' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberPreExDiag: required: - diagnostic_Code_Type - from_Diag - member_Seq - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string description: 'Identifies the ICD version of the associated diagnosis codes. Note: This field is marked as NOT NULL in the database and therefore required by the API.' from_Diag: maxLength: 8 minLength: 1 type: string description: Identifies the beginning diagnosis code for the associated range during the Member's preexisting condition period. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true thru_Diag: maxLength: 8 type: string description: Identifies the ending diagnosis code for the associated range during the Member's preexisting condition period. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberPreExDiagListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberPreExDiag' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberPreExDiagVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberPreExDiag' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberPreExDisclosedDiag: required: - diagnostic_Code_Type - member_Seq - memberPreExDisclosedDiag_Key - subscriber_ID type: object properties: memberPreExDisclosedDiag_Key: type: integer description: 'Unique identifier for each Member Pre Ex Disclosed Diag entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string description: Unique ID for the diagnostic code type. diagnostic_Group: maxLength: 32 type: string description: Name for the diagnostic group. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true from_Diag: maxLength: 8 type: string description: First Diagnosis Code for the specified range. nullable: true member_Seq: maxLength: 2 minLength: 1 type: string description: Sequential identifier assigned to the Member. subscriber_ID: maxLength: 9 minLength: 1 type: string description: Identifier assigned to the Subscriber associated with this Member. thru_Diag: maxLength: 8 type: string description: Last Diagnosis Code for the specified range. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberPreExDisclosedDiagListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberPreExDisclosedDiag' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberPreExDisclosedDiagVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberPreExDisclosedDiag' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberPriorAccum: required: - allowed_Amt - allowed_Amt_Net - allowed_Amt_OON - auto_Generated - benefit_Code - benefit_Used - benefit_Used_Net - benefit_Used_OON - billed_Amt - billed_Amt_Net - billed_Amt_OON - coB_Amt - coB_Amt_Net - coB_Amt_OON - coins_Amt - coins_Amt_Net - coins_Amt_OON - copay_Amt - copay_Amt_Net - copay_Amt_OON - ded_PPO_Used - deductible_Used - deductible_Used_OON - division_ID - group_ID - member_Seq - not_Covered_Amt - not_Covered_Amt_Net - not_Covered_Amt_OON - out_Of_Pocket - out_Of_Pocket_Net - out_Of_Pocket_OON - plan_Type - plan_Year - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. group_ID: maxLength: 20 minLength: 1 type: string description: Identifier assigned to the Group associated with this Member. division_ID: maxLength: 20 minLength: 1 type: string description: Division associated with this Prior Accumulator. plan_Year: maxLength: 8 minLength: 1 type: string description: Plan Year tied to this Prior Accumulator. plan_Type: maxLength: 6 minLength: 1 type: string description: Plan Type tied to this Prior Accumulator. benefit_Code: maxLength: 10 minLength: 1 type: string description: Benefit Code associated with this Member Prior Accumulator. added_Accum: maxLength: 1 type: string description: Selecting this option indicates that this Accumulator is an Added Accumulator. nullable: true allowed_Amt: type: number description: 'Total Allowed amount. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double allowed_Amt_Net: type: number description: 'Allowed amount that has been used In Network. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double allowed_Amt_OON: type: number description: 'Allowed amount that has been used Out of Network. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double auto_Generated: type: boolean description: 'Identifies that the prior accumulator was automatically generated. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' benefit_Used: type: number description: 'Total amount of benefit that has been used. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double benefit_Used_Net: type: number description: 'In network amount of benefit that has been used. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double benefit_Used_OON: type: number description: 'Amount of benefit that has been used Out of Network. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double billed_Amt: type: number description: 'Amount that has been billed. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double billed_Amt_Net: type: number description: 'Amount that has been billed In Network. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double billed_Amt_OON: type: number description: 'Amount that has been billed Out of Network. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double coB_Amt: type: number description: 'Total Coordination of Benefits amount that has been used. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double coB_Amt_Net: type: number description: 'In Network Coordination of Benefits amount that has been used. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double coB_Amt_OON: type: number description: 'Coordination of Benefits amount that has been used Out of Network. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double coins_Amt: type: number description: 'Total amount of Coinsurance that has been used. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double coins_Amt_Net: type: number description: 'In Network amount of Coinsurance that has been used. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double coins_Amt_OON: type: number description: 'Amount of Coinsurance that has been used Out of Network. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double copay_Amt: type: number description: 'Total amount of Copay that has been used. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double copay_Amt_Net: type: number description: 'In Network amount of Copay that has been used. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double copay_Amt_OON: type: number description: 'Amount of Copay that has been used Out of Network. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double currency_ID: maxLength: 16 type: string description: Indicates the currency used for this Accumulator. nullable: true ded_PPO_Used: type: number description: 'In Network amount of deductible that has been used. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double deductible_Used: type: number description: 'Total amount of deductible that has been used. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double deductible_Used_OON: type: number description: 'Amount of deductible that has been used Out of Network. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true not_Covered_Amt: type: number description: 'Total amount that is not covered. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double not_Covered_Amt_Net: type: number description: 'In Network amount that is not covered. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double not_Covered_Amt_OON: type: number description: 'Out of Network amount that is not covered. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double out_Of_Pocket: type: number description: 'Total Out of Pocket amount that has been used. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double out_Of_Pocket_Net: type: number description: 'Amount of Out of Pocket that has been used In Network. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double out_Of_Pocket_OON: type: number description: 'Amount of Out of Pocket that has been used Out of Network. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberPriorAccumListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberPriorAccum' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberPriorAccumVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberPriorAccum' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberProvider: required: - effective_Date - member_Seq - memberProvider_Key - provider_ID - subscriber_ID type: object properties: memberProvider_Key: type: integer description: 'Unique identifier for each PCP record attached to this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 capitation_Category: maxLength: 8 type: string description: Specifies the capitation category. nullable: true effective_Date: type: string description: 'Date when the Provider became the Member''s PCP. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time end_Date: type: string description: Date when the Member left the Provider as their PCP. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ipA_Number: maxLength: 16 type: string description: Information field used for custom reporting and interfaces. nullable: true member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. provider_ID: maxLength: 20 minLength: 1 type: string description: Provider designated this Member's PCP. reason_Code: type: integer description: Specifies the reason for the Member leaving the Provider as their PCP. format: int32 nullable: true subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberProviderAlternate: required: - memberProvider_Key - provider_ID type: object properties: memberProvider_Key: type: integer description: 'References MemberProvider.MemberProvider_Key value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 provider_ID: maxLength: 20 minLength: 1 type: string description: References MemberProvider.Provider_ID value on the parent record. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberProviderAlternateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberProviderAlternate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberProviderAlternateVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberProviderAlternate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberProviderListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberProvider' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberProviderVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberProvider' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberTax: required: - exemptions - federal_Tax_Exempt - medicare_Tax_Exempt - memberTax_Key - socSec_Tax_Exempt - state_Percentage_Election - state_Tax_Exempt - tax_Exempt - w4_2020 - w4_Box_C type: object properties: memberTax_Key: type: integer description: 'Unique identier for each Tax configuration on this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 annual_Withholding_Allowance: type: number description: Member's state annual withholding allowance as listed on the Member's tax documents. format: double nullable: true auxiliary: type: number description: Member's auxilary amounts as listed on the Member's tax documents. format: double nullable: true deductions_Amt: type: number description: Member's deductions amount as listed on the Member's tax documents. format: double nullable: true dependant_Withholding_Amt: type: number description: Member's dependant withholding amount as listed on the Member's tax documents. format: double nullable: true effective_From: type: string description: Date when the Member's tax record becomes/became effective. format: date-time nullable: true effective_Thru: type: string description: Date when the Member's tax record expires/expired. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exemptions: type: integer description: 'Member''s exemptions as listed on the Member''s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 exemptions_State: type: integer description: State of the Member's exemptions as listed on the Member's tax documents. format: int32 nullable: true extra_Withholding_Amt: type: number description: Member's extra withholding amount as listed on the Member's tax documents. format: double nullable: true federal_Tax_Exempt: type: boolean description: 'Member''s federal exemption status as listed on the Member''s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.' filing_Status: type: integer description: Member's filing status as listed on the Member's tax documents. format: int32 nullable: true filing_Status_State: type: integer description: Member's filing status for state taxes as listed on the Member's tax documents. format: int32 nullable: true flat_Tax: type: number description: Member's federal flat tax amount as listed on the Member's tax documents. format: double nullable: true flat_Tax_State: type: number description: Member's state flat tax amount as listed on the Member's tax documents. format: double nullable: true gross_Salary: type: number description: Member's gross salary as listed on the Member's tax documents. format: double nullable: true hours_Worked: type: number description: Number of hours the Member worked at the specified frequency as listed on the Member's tax documents. format: double nullable: true hours_Worked_Frequency: maxLength: 1 type: string description: Frequency at which the Member worked the specified number of hours as listed on the Member's tax documents. nullable: true local_Tax_Code: maxLength: 128 type: string description: Member's local tax code as listed on the Member's tax documents. nullable: true medicare_Tax_Exempt: type: boolean description: 'Member''s medicare exemption status as listed on the Member''s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.' member_Seq: maxLength: 2 type: string description: References Members.Member_Seq value on the parent record. nullable: true miscellaneous: type: number description: Member's miscellaneous amounts as listed on the Member's tax documents. format: double nullable: true net_Salary: type: number description: Member's net salary as listed on the Member's tax documents. format: double nullable: true other_Income_Amt: type: number description: Member's other income amount as listed on the Member's tax documents. format: double nullable: true percentage_Election: type: number description: Member's election percentage at the federal level as listed on the Member's tax documents. format: double nullable: true socSec_Tax_Exempt: type: boolean description: 'Member''s social security exemption status as listed on the Member''s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.' state_Percentage_Election: type: boolean description: 'Member''s election percentage at the state level as listed on the Member''s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.' state_Tax_Exempt: type: boolean description: 'Member''s tax exemption status as listed on the Member''s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.' state_Withholding: type: number description: 'Holds a numeric value listed as withholding, used in conjunction with Tax Control.' format: double nullable: true subscriber_ID: maxLength: 9 type: string description: References Members.Subscriber_ID value on the parent record. nullable: true tax_Exempt: type: boolean description: 'Member''s exemption status as listed on the Member''s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.' tips: type: number description: Member's amount of tips as listed on the Member's tax documents. format: double nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true w4_2020: type: boolean description: 'Specifies that the associated W4 is from 2020. Note: This field is marked as NOT NULL in the database and therefore required by the API.' w4_Box_C: type: boolean description: 'Specifies whether Box C was checked according to the Member''s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false MemberTaxListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberTax' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberTaxVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberTax' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberTooth: required: - claim_Entered - member_Seq - memberTooth_Key - subscriber_ID - tooth_Number - user_Entered type: object properties: memberTooth_Key: type: integer description: 'Unique identifier for each Tooth tracking record on this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 claim_Entered: type: boolean description: 'Identifies that the information was automatically entered based upon claim information. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. tooth_Number: type: integer description: 'Identifies the number of the tooth/teeth that the User intends to change the status of. Teeth may also be selected using one of the group buttons such as Right, left; molars, incisors; upper, lower; etc. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 tooth_Status: maxLength: 2 type: string description: 'Sets the status of the selected tooth/teeth. Teeth can be set as extracted, crowned, bridged, root, or cleared.' nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true user_Entered: type: boolean description: 'Idenfities that the information was manually entered by a User. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false MemberToothExCode: required: - ex_Code - member_Seq - subscriber_ID - tooth_Number type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. tooth_Number: type: integer description: 'Identifies the number of the tooth/teeth that the User intends to apply an Ex Code to. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 8 minLength: 1 type: string description: Idenfities the Ex Code that will be applied to the selected tooth/teeth. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false MemberToothExCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberToothExCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberToothExCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberToothExCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberToothListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberTooth' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberToothVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberTooth' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberVBAPlanTypeID: required: - member_Seq - subscriber_ID - vbA_Plan_Type type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Members.Subscriber_ID value on the parent record. member_Seq: maxLength: 2 minLength: 1 type: string description: References Members.Member_Seq value on the parent record. vbA_Plan_Type: maxLength: 32 minLength: 1 type: string description: Plan type associated with the Member's alternate ID. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true vbA_Plan_Type_ID: maxLength: 32 type: string description: Member's alternate ID for the associated plan type. nullable: true additionalProperties: false MemberVBAPlanTypeIDListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MemberVBAPlanTypeID' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MemberVBAPlanTypeIDVBAResponse: type: object properties: data: $ref: '#/components/schemas/MemberVBAPlanTypeID' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Members: required: - adult_Dependent - continue_Coverage - initial_Volume_Salary_Pct - other_Insurance - smoker - subscriber_ID - use_Member_Plan_Year type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References the Subscribers.Subscriber_ID value in the parent table. member_Seq: maxLength: 2 type: string description: "Sequential identifier assigned to each Member of this family. In combination with Subscriber_ID, creates a unique identifier. \r\nDuring creation, if you pass a value for this field, the system will attemot to use the value. If you do not include a value (eg, leave null), the system will generate a value for you. The generated value will be the total_count_of_members for the subscriber_id + 1." nullable: true access_Code: maxLength: 32 type: string description: Access code defined by the User. nullable: true adult_Child: maxLength: 1 type: string description: Designates whether the Member is an adult or child. This may be important in cases where premiums differ between adult and child members. nullable: true adult_Dependent: type: boolean description: This flag identifies the Member has been approved to continue coverage past the 'Cutoff Age' defined at the 'Group level'. adult_Dependent_End: type: string description: End date of the Member's approved 'Adult Dependent Status'. Only claims with a date of service up to this date will be allowed to process through adjudication. format: date-time nullable: true alternate_ID: maxLength: 32 type: string description: Allows the User to assign an 'Alternate ID' to the Member. nullable: true birth_Date: type: string description: Date of birth of the Member. format: date-time nullable: true continue_Coverage: type: boolean description: 'Allows claims to pay past the disenroll date. Below are some examples: (1) A member terminates coverage but is still inpatient. Checking this box, and designating the end of inpatient stay with the ''Thru Date'', will allow the claim(s) to pay during this time. The member will still reflect as inactive. (2) A member is on ''Long Term Disability''. Coverage terminates, but payments still need to be made. Same steps as example (1) above.' continue_Coverage_End_Date: type: string description: End date of the 'Continued Coverage' period. format: date-time nullable: true continue_Coverage_Ex_Code: maxLength: 6 type: string description: Allows for an Ex Code to be assigned when a claim is processed after the disenroll date but within the 'Continue Coverage' period. nullable: true coverage_Type: maxLength: 32 type: string description: 'Indicates the type of coverage (''Open Enrollment'', ''Late Enrollment'', etc.).' nullable: true credible_Coverage: type: integer description: Total number of days for the Credible Coverage period. format: int32 nullable: true creditable_Coverage_End: type: string description: End date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports. format: date-time nullable: true creditable_Coverage_Start: type: string description: Start date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports. format: date-time nullable: true date_Enrolled: type: string description: Original enrollment date of the Member. format: date-time nullable: true date_Of_Death: type: string description: Date of death of the Member. format: date-time nullable: true disenroll_Date: type: string description: Disenrollment date of the Member. format: date-time nullable: true ethnicity_Code: maxLength: 1 type: string description: Ethnicity of the Member. nullable: true first_Name: maxLength: 25 type: string description: First name of the Member. nullable: true height: type: integer description: The members height in inches. format: int32 nullable: true initial_Volume: type: number description: This is the volume used in intial volume calculations. This number can either be a flat amount or a percentage of the Member's gross salary. format: double nullable: true initial_Volume_Salary_Pct: type: boolean description: Indicates that the number from the 'Initial Volume' field represents a percentage of the Member's salary. Salaries are found from a Member's 'Financial' detail dropdown. last_Name: maxLength: 25 type: string description: Last name of the Member. nullable: true marital_Status: maxLength: 1 type: string description: Marital status of the Member. nullable: true middle_Name: maxLength: 25 type: string description: Middle initial of the Member. nullable: true name_Suffix: maxLength: 16 type: string description: Suffix or title associated with the Member. nullable: true notes: type: string description: 'No longer in use. Replaced by NotData, NoteSource and NoteReference tables.' nullable: true other_Insurance: type: boolean description: 'An optional reminder that the Member has an ''Other Insurance''. [Informational Only]' other_Name: maxLength: 96 type: string description: Information only used in custom reporting. nullable: true pend_Ex_Code: maxLength: 6 type: string description: Assigns an Ex Code that can be applied to newly adjudicated Subscriber claims. nullable: true pend_Flag: maxLength: 1 type: string description: 'While active, assigned Ex Codes will be applied to any newly adjudicated Subscriber claims.' nullable: true plan_Year_Frequency: type: integer description: Defines the number of months/years covered by the Member's plan. format: int32 nullable: true plan_Year_Frequency_Type: maxLength: 1 type: string description: Specifies the timeframe the Member Plan Year will use. nullable: true pre_Exist: maxLength: 1 type: string description: Identifies whether the Member has any pre-existing conditions. nullable: true pre_Exist_End: type: string description: End date of pre-existing conditions in relation to the Member's plan. format: date-time nullable: true pre_Exist_Ex_Code: maxLength: 6 type: string description: Assigns an Ex Code to pre-existing Claims. nullable: true relationship: maxLength: 12 type: string description: Relationship of the Member to the Subscriber. nullable: true ssn: maxLength: 32 type: string description: Social security number of the Member. nullable: true salutation: maxLength: 16 type: string description: Information only used in custom reporting. nullable: true sex: maxLength: 1 type: string description: Biological sex of the Member. nullable: true smoker: type: boolean description: Designates whether the Member is a smoker. This may be important in cases where premiums differ between smokers and non-smokers. student: maxLength: 1 type: string description: Identifies that the Member meets the 'Student Status' requirements. nullable: true student_End: type: string description: End date of the Member's approved 'Student Status'. Only claims with a date of service up to this date will be allowed to process through adjudication. format: date-time nullable: true unique_ID: maxLength: 32 type: string description: Unique identifier assigned to the Member by the User. nullable: true use_Member_Plan_Year: type: boolean description: Identifies the Member's Plan year if it differs from the group. The User is required to define a number of months or years for the Plan. The Member's Plan year will begin on the first day of enrollment. viP_Flag: maxLength: 1 type: string description: VIP status of the Member. This status can be used as a search filter but is otherwise informational only. nullable: true weight: type: integer description: The members weight in pounds. format: int32 nullable: true additionalProperties: false MembersListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Members' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MembersVBAResponse: type: object properties: data: $ref: '#/components/schemas/Members' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Modifier: required: - modifier_Code type: object properties: modifier_Code: maxLength: 8 minLength: 1 type: string description: Code identifying the procedure code modifier effective_Date: type: string description: Date the modifier becomes effective format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true fee_Percent: type: number description: Percentage used when the modifier is applied format: double nullable: true modifier_Description: maxLength: 100 type: string description: Description of the procedure code modifier nullable: true term_Date: type: string description: Date the modifier terminates format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ModifierListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Modifier' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ModifierVBAResponse: type: object properties: data: $ref: '#/components/schemas/Modifier' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MostVisited: type: object properties: object_Title: type: string nullable: true display_Text: type: string nullable: true object_Count: type: integer format: int32 additionalProperties: false MostVisitedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MostVisited' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false MultiCodeResponse: required: - body - id - status type: object properties: id: type: array items: $ref: '#/components/schemas/KeyValuePair' description: List of key/value pairs that represent the unique id for the entity operation. readOnly: true status: type: integer description: 'http status of the operation (eg, 200, 201, 500)' format: int32 readOnly: true body: minLength: 1 type: string description: 'operation message (eg, Updated, Created, Error message)' readOnly: true additionalProperties: false description: RThe MultiCodeResponse provides status for multiple independent operations. MultiCodeResponseListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MultiCodeResponse' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkCriteria: type: object properties: network_ID: type: string nullable: true additionalProperties: false NetworkModifier: required: - effective_Date - modifier - network_ID type: object properties: network_ID: maxLength: 50 minLength: 1 type: string modifier: maxLength: 8 minLength: 1 type: string effective_Date: type: string format: date-time entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true fee_Percent: type: number format: double nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false NetworkModifierListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NetworkModifier' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkModifierVBAResponse: type: object properties: data: $ref: '#/components/schemas/NetworkModifier' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkPracticeType: required: - context4Fg - effective_Date - network_ID - practice_Type type: object properties: network_ID: maxLength: 50 minLength: 1 type: string practice_Type: maxLength: 16 minLength: 1 type: string effective_Date: type: string format: date-time context4Fg: type: boolean entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true fee_Percent: type: number format: double nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false NetworkPracticeTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NetworkPracticeType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkPracticeTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/NetworkPracticeType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkProcedureCluster: required: - context4Fg - effective_Date - network_ID - procedure_Cluster type: object properties: network_ID: maxLength: 50 minLength: 1 type: string description: Unique identifier assigned to the network. procedure_Cluster: maxLength: 32 minLength: 1 type: string description: Identifies the procedure cluster that is to be tied to the pricing rule. effective_Date: type: string description: 'Date when the pricing rule becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time bill_Percent: type: number description: 'Used with the pricing claimrule, sets a value for the allowed amount to a percentage of the billed amount during adjudication. Subsequent claimrules may affect pricing.' format: double nullable: true claim_Type: maxLength: 20 type: string description: Defines what type of claims the Network Procedure Cluster applies to nullable: true context4Fg: type: boolean description: 'This option tells the pricing rule to reference pricing received from Context4. If this is unchecked, it allows the User to have the functionality without the Context4 hook. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true fee_Percent: type: number description: Specifies the fee percentage that is to be tied to the selected procedure cluster. Negative values will apply a discount. format: double nullable: true flat_Rate: type: number description: 'Used with the pricing claimrule, sets a value for the allowed amount during adjudication. Subsequent claimrules may affect pricing.' format: double nullable: true term_Date: type: string description: Date when the pricing rule expires/expired. format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false NetworkProcedureClusterListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NetworkProcedureCluster' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkProcedureClusterVBAResponse: type: object properties: data: $ref: '#/components/schemas/NetworkProcedureCluster' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkProfile: required: - profile_ID type: object properties: profile_ID: maxLength: 32 minLength: 1 type: string description: Unique idenfitier assigned to the Network Profile record. description: maxLength: 512 type: string description: Description of the Network Profile. nullable: true display: maxLength: 64 type: string description: Display name of the Network Profile. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 200 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false NetworkProfileAssign: required: - assign_ID - assign_Type - effective_Date - profile_ID type: object properties: profile_ID: maxLength: 32 minLength: 1 type: string description: Unique idenfitier assigned to the Network Profile record. assign_Type: maxLength: 16 minLength: 1 type: string description: 'Defines the type of record match used by the assignment. Supports Provider_ID, Profile_Provider_ID, or Federal_ID' assign_ID: maxLength: 64 minLength: 1 type: string description: Holds ID value used in conjunction with the Assign_Type to define the desired provider match. effective_Date: type: string description: 'Date when the Network Profile becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 200 type: string description: User that first added the record to the system nullable: true term_Date: type: string description: Date when the Network Profile no longer applies. format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false NetworkProfileAssignListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NetworkProfileAssign' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkProfileAssignVBAResponse: type: object properties: data: $ref: '#/components/schemas/NetworkProfileAssign' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkProfileListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NetworkProfile' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkProfileNetwork: required: - eff_Date - network_ID - profile_ID - use_No_Proc_In_Fee type: object properties: profile_ID: maxLength: 32 minLength: 1 type: string description: Unique idenfitier assigned to the Proivider record. network_ID: maxLength: 10 minLength: 1 type: string description: Indicates which Network the options will be associated with. eff_Date: type: string description: 'Start of the range of acceptable service dates for the network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time claim_Days_Allowed: type: integer description: No longer in use. format: int32 nullable: true disc_Pct: type: number description: Indicates the discount percentage that will be applied to the selected fee schedule. format: double nullable: true disc_Pct_2: type: number description: Indicates the discount percentage that will be applied to the secondary selected fee schedule. format: double nullable: true entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true fee_Sched: maxLength: 8 type: string description: Allows the User to select an existing fee schedule to base their pricing upon. nullable: true fee_Sched_2: maxLength: 8 type: string description: Allows the User to select a secondary existing fee schedule to base their pricing upon. nullable: true no_Proc_In_Fee_Disc_Pct: type: number description: This is the adjustment percentage that will be used if the 'Use Not in Fee Adj.' option is selected. format: double nullable: true priority: type: integer description: Indicates the network-level priority of the Provider's network affiliation. This priority is used in the adjudication calculation to assign networks. The network with the lowest sum (network level priority + group level priority) will be assigned. format: int32 nullable: true reason_Comment: maxLength: 1024 type: string description: Allows the User to add any relevant notes regarding the reason for termination. nullable: true reason_ID: type: integer description: Indicates the reason for termination of the associated network. format: int32 nullable: true term_Date: type: string description: End of the range of acceptable service dates for the network. format: date-time nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true use_No_Proc_In_Fee: type: boolean description: 'If a procedure code match can not be found in the selected fee schedule, adjudication will use a flat adjustment percentage instead. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false NetworkProfileNetworkListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NetworkProfileNetwork' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkProfileNetworkVBAResponse: type: object properties: data: $ref: '#/components/schemas/NetworkProfileNetwork' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkProfileVBAResponse: type: object properties: data: $ref: '#/components/schemas/NetworkProfile' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkType: required: - network_Type type: object properties: network_Type: maxLength: 16 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false NetworkTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NetworkType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworkTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/NetworkType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Networks: required: - networkID type: object properties: networkID: maxLength: 10 minLength: 1 type: string description: Unique identifier assigned to the network. apC_Schedule: maxLength: 16 type: string description: Identifies the default APC schedule that is to be used for the network. nullable: true address: maxLength: 128 type: string description: Address line 1 of the network. nullable: true address_2: maxLength: 128 type: string description: Address line 2 of the network. nullable: true city: maxLength: 32 type: string description: City of the network's address. nullable: true claim_Days_Allowed: type: integer description: This option is informational only and currently has no functionality. format: int32 nullable: true drG_Schedule: maxLength: 16 type: string description: Identifies the default DRG schedule that is to be used for the network. nullable: true eMail: maxLength: 128 type: string description: Email of the Network. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 8 type: string description: Specifies the Ex Code that will be applied while the Ex Code flag is selected. nullable: true ex_Code_Flag: maxLength: 1 type: string description: This option tells adjudication to apply an Ex Code to claims associated with the network. nullable: true fax: maxLength: 32 type: string description: Fax number of the Network. nullable: true logo_File: maxLength: 255 type: string description: Allows the User to upload a logo that can be attached to custom reporting. nullable: true networkDescription: maxLength: 512 type: string description: Description of the associated network. nullable: true phone: maxLength: 32 type: string description: Phone number of the Network. nullable: true state: maxLength: 2 type: string description: State of the network's address. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true withhold_Percent: type: number description: This option is informational only and currently has no functionality. format: double nullable: true zip_Code: maxLength: 32 type: string description: Zip code of the Network's address. nullable: true additionalProperties: false NetworksListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Networks' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NetworksVBAResponse: type: object properties: data: $ref: '#/components/schemas/Networks' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteAttachment: required: - attachment_Key - note_Key type: object properties: attachment_Key: type: integer description: 'Key value identifying an attachment to a note Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 attachment: type: string description: Attachment data assocaited with a note format: byte nullable: true attachment_File: maxLength: 255 type: string description: Name of the file that has been uploaded as an attachment. nullable: true attachment_Path: maxLength: 500 type: string description: Path of the file that has been uploaded as an attachment. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true note_Key: type: integer description: 'Key value identifying the note that attachment is associated with Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false NoteAttachmentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NoteAttachment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteAttachmentVBAResponse: type: object properties: data: $ref: '#/components/schemas/NoteAttachment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteCategory: required: - allow_Note_Alert - note_Category type: object properties: note_Category: maxLength: 8 minLength: 1 type: string description: Name of the 'Note Category'. allow_Note_Alert: type: boolean description: 'Checking this option allows the system to generate alerts for this ''Note Category''. Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 64 type: string description: Description of the 'Note Category'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true key_Column: maxLength: 1024 type: string description: Internal use only. This is a comma separated list of fields used to create the NoteSource record for a new or existing note. nullable: true location: maxLength: 50 type: string description: Identifier of the location for the 'Note Category'. nullable: true navigate_Object: maxLength: 128 type: string description: Internal use only. Holds the navigation object used when navigating through the VBASoftware application. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false NoteCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NoteCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteCategoryType: required: - note_Category - note_Type type: object properties: note_Category: maxLength: 8 minLength: 1 type: string description: Identifier of the category of the note note_Type: maxLength: 8 minLength: 1 type: string description: Identifies a 'Note Type' for the selected 'Note Category'. additionalProperties: false NoteCategoryTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NoteCategoryType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteCategoryTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/NoteCategoryType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/NoteCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteData: required: - note_Alert - note_Key type: object properties: note_Key: type: integer description: Key value used to identify a specific note format: int32 effective_Date: type: string description: Date the information in the note goes into effect format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true note_Alert: type: boolean description: Flag identifying if there is an alert associated with the note note_Alert_End: type: string description: Date the alert associated with a note terminates format: date-time nullable: true note_Category: maxLength: 8 type: string description: Identifies the 'Category' of note. Note 'Category' are configured within 'Note Configuration'. nullable: true note_Data: type: string description: Text data of the note. nullable: true note_Priority: maxLength: 8 type: string description: Identifies the 'Priority' of note. Note 'Priority' are configured within 'Note Configuration'. nullable: true note_Subject: maxLength: 64 type: string description: Description of the note's subject. nullable: true note_Type: maxLength: 8 type: string description: Identifies the 'Type' of note. Note 'Types' are configured within 'Note Configuration'. nullable: true term_Date: type: string description: Date the information in the note terminates format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false NoteDataListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NoteData' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteDataVBAResponse: type: object properties: data: $ref: '#/components/schemas/NoteData' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NotePriority: required: - note_Priority type: object properties: note_Priority: maxLength: 8 minLength: 1 type: string description: Name of the 'Note Priority'. description: maxLength: 32 type: string description: Description of the 'Note Priority'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true priority_Order: type: integer description: Identifies the hierarchy of the note. Notes will be assigned based on priority in ascending order (1 being highest priority). format: int32 nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false NotePriorityListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NotePriority' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NotePriorityVBAResponse: type: object properties: data: $ref: '#/components/schemas/NotePriority' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteReference: required: - column_Name1 - key_Value1 - note_Key - reference_Key type: object properties: reference_Key: type: integer description: 'ID of the note reference. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 column_Name1: maxLength: 128 minLength: 1 type: string description: Defines the subject of 'Key_Value1'. column_Name2: maxLength: 128 type: string description: Defines the subject of 'Key_Value2'. nullable: true column_Name3: maxLength: 128 type: string description: Defines the subject of 'Key_Value3'. nullable: true column_Name4: maxLength: 128 type: string description: Defines the subject of 'Key_Value4'. nullable: true column_Name5: maxLength: 128 type: string description: Defines the subject of 'Key_Value5'. nullable: true column_Type1: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value1'. nullable: true column_Type2: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value2'. nullable: true column_Type3: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value3'. nullable: true column_Type4: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value4'. nullable: true column_Type5: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value5'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true key_Value1: maxLength: 128 minLength: 1 type: string description: Value of the subject specified by 'Column_Name1'. key_Value2: maxLength: 128 type: string description: Value of the subject specified by 'Column_Name2'. nullable: true key_Value3: maxLength: 128 type: string description: Value of the subject specified by 'Column_Name3'. nullable: true key_Value4: maxLength: 128 type: string description: Value of the subject specified by 'Column_Name4'. nullable: true key_Value5: maxLength: 128 type: string description: Value of the subject specified by 'Column_Name5'. nullable: true navigate_Object: maxLength: 128 type: string description: PowerBuilder object connected to the note that is used for navigation nullable: true note_Key: type: integer description: 'ID of the associated note. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false NoteReferenceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NoteReference' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteReferenceVBAResponse: type: object properties: data: $ref: '#/components/schemas/NoteReference' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteSource: required: - column_Name1 - key_Value1 - note_Key - source_Key type: object properties: source_Key: type: integer description: 'ID of the note source. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 column_Name1: maxLength: 128 minLength: 1 type: string description: Defines the subject of 'Key_Value1'. column_Name2: maxLength: 128 type: string description: Defines the subject of 'Key_Value2'. nullable: true column_Name3: maxLength: 128 type: string description: Defines the subject of 'Key_Value3'. nullable: true column_Name4: maxLength: 128 type: string description: Defines the subject of 'Key_Value4'. nullable: true column_Name5: maxLength: 128 type: string description: Defines the subject of 'Key_Value5'. nullable: true column_Type1: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value1'. nullable: true column_Type2: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value2'. nullable: true column_Type3: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value3'. nullable: true column_Type4: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value4'. nullable: true column_Type5: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value5'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true key_Value1: maxLength: 128 minLength: 1 type: string description: Value of the subject specified by 'Column_Name1'. key_Value2: maxLength: 128 type: string description: Value of the subject specified by 'Column_Name2'. nullable: true key_Value3: maxLength: 128 type: string description: Value of the subject specified by 'Column_Name3'. nullable: true key_Value4: maxLength: 128 type: string description: Value of the subject specified by 'Column_Name4'. nullable: true key_Value5: maxLength: 128 type: string description: Value of the subject specified by 'Column_Name5'. nullable: true navigate_Object: maxLength: 128 type: string description: PowerBuilder object connected to the note that is used for navigation nullable: true note_Key: type: integer description: 'ID of the associated note. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false NoteSourceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NoteSource' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteSourceVBAResponse: type: object properties: data: $ref: '#/components/schemas/NoteSource' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteType: required: - note_Type type: object properties: note_Type: maxLength: 8 minLength: 1 type: string description: Name of the 'Note Type'. description: maxLength: 64 type: string description: Description of 'Note Type'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false NoteTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NoteType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false NoteTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/NoteType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Note_NoteAttachment: type: object properties: noteData: $ref: '#/components/schemas/NoteData' noteAttachments: type: array items: $ref: '#/components/schemas/NoteAttachment' nullable: true additionalProperties: false ObjectList: required: - object_Name type: object properties: object_Name: maxLength: 128 minLength: 1 type: string description: Name of the object or window used by the application code advanced_Search_Calculated_Column: maxLength: 1024 type: string description: Computed column used for Advanced Search with the object or window nullable: true advanced_Search_Table: maxLength: 512 type: string description: Table used for Advanced Search with the object or window nullable: true advanced_Search_Type: maxLength: 64 type: string description: Type of Advanced Search used with the object or window nullable: true description: type: string description: Description of the object or window in the application nullable: true functional_Area: maxLength: 64 type: string description: Identifier of the functional area in the application where the object or window is found nullable: true help_File: maxLength: 256 type: string description: Help file that is associated with the object or window nullable: true help_Topic_ID: type: integer description: ID of the help topic within the file format: int32 nullable: true object_Library: maxLength: 256 type: string description: Library in the application where the object or window is stored nullable: true object_Title: maxLength: 256 type: string description: Title of the object or window displayed in the application nullable: true purpose: maxLength: 32 type: string description: Identifier of the object or windows purpose nullable: true additionalProperties: false ObjectListListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ObjectList' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Occupation: required: - occupation_ID type: object properties: occupation_ID: maxLength: 32 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true occupation_Description: type: string nullable: true occupation_Display: maxLength: 128 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false OccupationListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Occupation' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false OccupationVBAResponse: type: object properties: data: $ref: '#/components/schemas/Occupation' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false OptionCriteria: type: object properties: run_Date: type: string format: date-time nullable: true capitation_Category: type: string nullable: true reason_ID: type: integer format: int32 nullable: true assignment_Rule1: type: string nullable: true assignment_Rule2: type: string nullable: true assignment_Rule3: type: string nullable: true assignment_Rule4: type: string nullable: true max_Radius: type: integer format: int32 nullable: true additionalProperties: false PBMType: required: - pbM_Type type: object properties: pbM_Type: maxLength: 8 minLength: 1 type: string description: Identifier for a specific PBM type description: maxLength: 64 type: string description: Description for a specific PBM type nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false PBMTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PBMType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PBMTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PBMType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Payee: required: - inactive - virtual_Office - void_Checks - w9_Received - wire_Transfer type: object properties: payee_ID: maxLength: 20 type: string description: 'Unique identifier assigned to the Payee. If a Payee ID is not provided, one will be assigned at the time of creation.' nullable: true address: maxLength: 255 type: string description: Address of the Payee. nullable: true address2: maxLength: 128 type: string description: Address line 2 of the Payee. nullable: true alternate_ID: maxLength: 20 type: string description: Field using for storing a custom alternate ID associated with this Payee. nullable: true blid: maxLength: 64 type: string description: The BaseLoad identifier associated with this Billing entity (Payee). nullable: true city: maxLength: 30 type: string description: City of the Payee's address. nullable: true contact: maxLength: 50 type: string description: Name of the desired contact person associated with the Payee. nullable: true country_ID: maxLength: 8 type: string description: Identifier of the country where the Payee resides. nullable: true email_Address: maxLength: 128 type: string description: Email address of the Payee. nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true fax_Country_Code: maxLength: 8 type: string description: Country code of the Payee's fax number. nullable: true fax_Number: maxLength: 20 type: string description: Fax number of the Payee. nullable: true federal_ID: maxLength: 15 type: string description: Identifier assigned to the Payee that is used for federal tax purposes. nullable: true inactive: type: boolean description: 'This field indicates that the Payee is currently inactive Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' latitude: type: number description: Latitudinal coordinates for the Payee's location. format: double nullable: true longitude: type: number description: Longitudinal coordinate for the Payee's location. format: double nullable: true name: maxLength: 128 type: string description: Name of the Payee. nullable: true name_For_Check: maxLength: 128 type: string description: Name that should be writen on checks that are made out to the Payee. Only provide this information if the name differs from the Payee name. nullable: true need_1099: maxLength: 1 type: string description: Indicates that the Payee needs a 1099 generated yearly by VBA. Checking this box enables additional 1099 address information. Only provide this information if it differs from the Payee address. nullable: true payTo_Address: maxLength: 128 type: string description: Address that should be used for payments to the Payee. Payments will default to the Payee address if this field is not completed. nullable: true payTo_Address2: maxLength: 128 type: string description: Line 2 of the address that should be used for payments to the Payee. nullable: true payTo_City: maxLength: 30 type: string description: City of the address that should be used for payments to the Payee. nullable: true payTo_Country_ID: maxLength: 8 type: string description: Identifier of the country where the Payee's payments are received. nullable: true payTo_State: maxLength: 2 type: string description: State of the Payee's address used for payments. nullable: true payTo_Zip: maxLength: 32 type: string description: Zip Code of the Payee's address used for payments. nullable: true pend_Ex_Code: maxLength: 6 type: string description: Specifies the Ex Code that should be applied when the 'Apply Ex Code' option is selected. nullable: true pend_Flag: type: boolean description: Indicates whether an Ex Code should be applied to claims that involve payments to the selected Payee. nullable: true phone_Country_Code: maxLength: 8 type: string description: Country code of the Payee's phone number. nullable: true phone_Number: maxLength: 20 type: string description: Phone number of the Payee. nullable: true state: maxLength: 2 type: string description: State of the Payee's address. nullable: true tax_Address: maxLength: 128 type: string description: Address that the Payee uses for tax purposes. nullable: true tax_Address2: maxLength: 128 type: string description: Address line 2 that the Payee uses for tax purposes. nullable: true tax_City: maxLength: 32 type: string description: City of the address that the Payee uses for tax purposes. nullable: true tax_Contact: maxLength: 64 type: string description: Contact that the Payee uses for tax purposes. nullable: true tax_Fax_Number: maxLength: 16 type: string description: Fax number of the Contact that the Payee uses for tax purposes. nullable: true tax_Name: maxLength: 64 type: string description: Name that the Payee uses for tax purposes. nullable: true tax_Phone_Number: maxLength: 16 type: string description: Phone number of the Contact that the Payee uses for tax purposes. nullable: true tax_State: maxLength: 2 type: string description: State of the address that the Payee uses for tax purposes. nullable: true tax_Zip_Code: maxLength: 16 type: string description: Zip Code of the address that the Payee uses for tax purposes. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true virtual_Office: type: boolean description: 'Indicates whether the Payee functions as a virtual office. This can be used for data exporting purposes. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' void_Checks: type: boolean description: 'No longer in use. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' w9_Received: type: boolean description: 'This field indicates that a W9 has been received from this Payee. This field is informational only. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' website: maxLength: 256 type: string description: Website of the Payee. nullable: true wire_Transfer: type: boolean description: 'Indicates whether the Payee account accepts wire transfers. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' zip_Code: maxLength: 32 type: string description: Zip Code of the Payee's address. nullable: true additionalProperties: false PayeeAccount: required: - account_Key - payee_ID - payeeAccount_Key - wire_Transfer type: object properties: payeeAccount_Key: type: integer format: int32 account_Key: type: integer format: int32 effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true payee_ID: maxLength: 20 minLength: 1 type: string term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true wire_Transfer: type: boolean additionalProperties: false PayeeAccountListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PayeeAccount' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayeeAccountVBAResponse: type: object properties: data: $ref: '#/components/schemas/PayeeAccount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayeeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Payee' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayeeVBAResponse: type: object properties: data: $ref: '#/components/schemas/Payee' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PaymentMethod: required: - payment_Method - payment_Method_ACH - payment_Method_Check type: object properties: payment_Method: maxLength: 20 minLength: 1 type: string description: The primary key of the payment method description: maxLength: 512 type: string description: The description of the payment method nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true payment_Method_ACH: type: boolean description: 'Flag identifying the Payment Method as an ACH transaction Note: This field is marked as NOT NULL in the database and therefore required by the API.' payment_Method_Check: type: boolean description: 'Flag identifying the Payment Method as a check Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false PaymentMethodListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PaymentMethod' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PaymentMethodVBAResponse: type: object properties: data: $ref: '#/components/schemas/PaymentMethod' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PaymentSchedule: required: - payment_Schedule type: object properties: payment_Schedule: maxLength: 32 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true schedule_Frequency: type: integer format: int32 nullable: true schedule_Type: maxLength: 1 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PaymentScheduleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PaymentSchedule' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PaymentScheduleVBAResponse: type: object properties: data: $ref: '#/components/schemas/PaymentSchedule' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Payor: required: - force_Filter - payor_ID type: object properties: payor_ID: maxLength: 20 minLength: 1 type: string description: Unique identifier assigned to the Payor. address: maxLength: 255 type: string description: Address of the Payor. nullable: true address2: maxLength: 128 type: string description: Address line 2 of the Payor. nullable: true admin_Fee: type: number description: Specifies the 'Admin Fee' amount that will be applied to the associated check. format: double nullable: true admin_Pct: maxLength: 1 type: string description: Identifies whether the associated 'Admin Fee' is a percentage. nullable: true city: maxLength: 25 type: string description: City of the Payor's address. nullable: true contact: maxLength: 50 type: string description: Name of the intended contact person for the Payor. nullable: true country_ID: maxLength: 8 type: string description: Identifier of the country where the Payor resides. nullable: true county_Code: maxLength: 8 type: string description: Indentifier of the county where the Payor resides. nullable: true default_Pay_Date_Range: type: integer description: This option allows the User to post-date 'Check Paid Date' field at the Payor level by the designated number of days. format: int32 nullable: true edI_ID: maxLength: 9 type: string description: EDI ID associated with the Payor. nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: Allows the User to select an Ex Code that will be applied to any claims associated with the Payor whenever the 'Apply Ex Code' option is selected. nullable: true fax_Country_Code: maxLength: 8 type: string description: Country code of the Payor's fax number. nullable: true fax_Number: maxLength: 20 type: string description: Fax number of the Payor. nullable: true federal_ID: maxLength: 32 type: string description: Identifier assigned to the Payor that is used for federal tax purposes. nullable: true force_Filter: type: boolean description: 'This option will limit filters available from the Claim Funding screen to the filters that have been built on the Funds Filter tab. Note: This field is marked as NOT NULL in the database and therefore required by the API.' last_Wire_Check: type: integer description: Displays the check number of the Payor's last wire transfer. format: int32 nullable: true name: maxLength: 100 type: string description: Name of the Payor individual or institution. nullable: true phone_Country_Code: maxLength: 8 type: string description: Country code of the Payor's phone number. nullable: true phone_Number: maxLength: 20 type: string description: Phone number of the Payor. nullable: true state: maxLength: 2 type: string description: State of the Payor's address. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true zip_Code: maxLength: 32 type: string description: Zip Code of the Payor's address. nullable: true additionalProperties: false PayorAccount: required: - account_Key - payor_Account_Key - payor_ID - single_Check_Per_Claim type: object properties: payor_Account_Key: type: integer description: 'Unique identifier for each Payor and Account combination. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 account_Key: type: integer description: 'References the FundingAccount.Account_Key associated with this Payor/Account. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 check_Stock: type: integer description: 'When a check is printed, the check will default to the selected check stock.' format: int32 nullable: true currency_ID: maxLength: 16 type: string description: Identifies the currency that is used by the Payor. nullable: true default_Contact_Method: maxLength: 32 type: string description: Identifies the desired default contact method of the Payor. nullable: true default_Funding_Format: maxLength: 32 type: string description: Identifies the desired default funding format of the Payor. nullable: true effective_Date: type: string description: Date when the Payor account becomes/became effective. format: date-time nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: Allows the User to select an Ex Code that will be applied to any claims associated with the Payor whenever the 'Apply Ex Code' option is selected. nullable: true funding_Threshold: type: integer description: This option is informational only. format: int32 nullable: true logo_File: maxLength: 256 type: string description: Displays the currently used logo file for the Payor. This logo can be applied to custom check stock. nullable: true payor_ID: maxLength: 20 minLength: 1 type: string description: References the Payor.Payor_ID associated with this Payor/Account. signatures_Required: type: integer description: This option is informational only. format: int32 nullable: true single_Check_Per_Claim: type: boolean description: 'Requires that this Payor''s claims be paid for with a single check. Note: This field is marked as NOT NULL in the database and therefore required by the API.' term_Date: type: string description: Date when the Payor account becomes/became terminated. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PayorAccountListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PayorAccount' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayorAccountNotify: required: - payor_Account_Key - user_ID type: object properties: payor_Account_Key: type: integer description: Unique identifier for this notification setting. format: int32 user_ID: maxLength: 16 minLength: 1 type: string description: The User ID to be notified by this setting. additionalProperties: false PayorAccountNotifyListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PayorAccountNotify' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayorAccountNotifyVBAResponse: type: object properties: data: $ref: '#/components/schemas/PayorAccountNotify' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayorAccountSignature: required: - effective_Date - payor_Account_Key - payorAccountSignature_Key - required - signature_Key type: object properties: payorAccountSignature_Key: type: integer description: 'Unique identifer for this Account Signature. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 effective_Date: type: string description: 'Date when the Payor signature becomes effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true payor_Account_Key: type: integer description: 'The Payor/Account that this signature definite is attached. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 required: type: boolean description: 'Indicates whether the Payor''s signature is always required. Note: This field is marked as NOT NULL in the database and therefore required by the API.' signature_Key: type: integer description: 'Select the signature to be used on this Payor''s check stock. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 term_Date: type: string description: Date when the Payor signature expires. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PayorAccountSignatureListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PayorAccountSignature' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayorAccountSignatureVBAResponse: type: object properties: data: $ref: '#/components/schemas/PayorAccountSignature' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayorAccountVBAResponse: type: object properties: data: $ref: '#/components/schemas/PayorAccount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayorFilter: required: - filter_Key - payor_ID - payorFilter_Key type: object properties: payorFilter_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true filter_Key: type: integer format: int32 payor_ID: maxLength: 20 minLength: 1 type: string update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PayorFilterListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PayorFilter' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayorFilterVBAResponse: type: object properties: data: $ref: '#/components/schemas/PayorFilter' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayorListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Payor' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayorReport: required: - payor_ID - report_Type - reportDefinition_Key type: object properties: payor_ID: maxLength: 20 minLength: 1 type: string reportDefinition_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true report_Type: maxLength: 16 minLength: 1 type: string update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PayorReportListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PayorReport' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayorReportVBAResponse: type: object properties: data: $ref: '#/components/schemas/PayorReport' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PayorVBAResponse: type: object properties: data: $ref: '#/components/schemas/Payor' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlaceCodes: required: - all_Places - exclude_Proc_Auth - place_Code type: object properties: place_Code: maxLength: 4 minLength: 1 type: string description: Code that identifies a specific place of service all_Places: maxLength: 1 minLength: 1 type: string description: 'Flag that identifies if a place code refers to all places of service Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 50 type: string description: Description of a specific place of service nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true exclude_Proc_Auth: type: boolean description: 'Flag that indicates if the place code will exclude an auth for procedures Note: This field is marked as NOT NULL in the database and therefore required by the API.' old_Place_Code: maxLength: 4 type: string description: Field identifying the old place code when the code on a place of service has changed nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false PlaceCodesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlaceCodes' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlaceCodesVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlaceCodes' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanAddedAccum: required: - accum_Name - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the Plans.Plan_ID for this Added Accumulator. accum_Name: maxLength: 10 minLength: 1 type: string description: Unique identifier for this Added Accumulator. This value must also be unique of any Benefit_Code value in BenefitCodes.Benefit_Code. annual_Max: type: number description: Total annual amount that the Plan will pay both In Network and Out of Network. format: double nullable: true annual_Max_Member: type: number description: Total annual amount that the Plan will pay both In Network and Out of Network. format: double nullable: true annual_Max_Net: type: number description: Annual amount that the Plan will pay In Network. format: double nullable: true annual_Max_Net_Member: type: number description: Annual amount that the Plan will pay In Network. format: double nullable: true annual_Max_OON: type: number description: Annual amount that the Plan will pay Out of Network. format: double nullable: true annual_Max_OON_Member: type: number description: Annual amount that the Plan will pay Out of Network. format: double nullable: true coIns_Max_Mem: type: number description: Total Co-Insurance amount for the Member. format: double nullable: true coIns_Max_Net_Mem: type: number description: In Network Co-Insurance amount for the Member. format: double nullable: true coIns_Max_Net_Sub: type: number description: In Network Co-Insurance amount for the Family. format: double nullable: true coIns_Max_OON_Mem: type: number description: Out of Network Co-Insurance amount for the Member. format: double nullable: true coIns_Max_OON_Sub: type: number description: Out of Network Co-Insurance amount for the Family. format: double nullable: true coIns_Max_Sub: type: number description: Total Co-Insurance amount for the Family. format: double nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true lifetime_Max: type: number description: Total lifetime amount that the Plan will pay both In Network and Out of Network. format: double nullable: true lifetime_Max_Member: type: number description: Total lifetime amount that the Plan will pay both In Network and Out of Network. format: double nullable: true lifetime_Max_Net: type: number description: Lifetime amount that the Plan will pay In Network. format: double nullable: true lifetime_Max_Net_Member: type: number description: Lifetime amount that the Plan will pay In Network. format: double nullable: true lifetime_Max_OON: type: number description: Lifetime amount that the Plan will pay Out of Network. format: double nullable: true lifetime_Max_OON_Member: type: number description: Lifetime amount that the Plan will pay Out of Network. format: double nullable: true member_Ded_OON: type: number description: Out of Network deductible amount for the Member. format: double nullable: true member_Ded_PPO: type: number description: In Network deductible amount for the Member. format: double nullable: true member_Deductible: type: number description: Total deductible amount for the Member. format: double nullable: true ooP_Max_Mem: type: number description: Total Out of Pocket amount for the Member. format: double nullable: true ooP_Max_Net_Mem: type: number description: In Network Out of Pocket amount for the Member. format: double nullable: true ooP_Max_Net_Sub: type: number description: In Network Out of Pocket amount for the Family. format: double nullable: true ooP_Max_OON_Mem: type: number description: Out of Network Out of Pocket amount for the Member. format: double nullable: true ooP_Max_OON_Sub: type: number description: Out of Network Out of Pocket amount for the Family. format: double nullable: true ooP_Max_Sub: type: number description: Total Out of Pocket amount for the Family. format: double nullable: true subscriber_Ded_OON: type: number description: Out of Network deductible amount for the Family. format: double nullable: true subscriber_Ded_PPO: type: number description: In Network deductible amount for the Family. format: double nullable: true subscriber_Deductible: type: number description: Total deductible amount for the Family. format: double nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanAddedAccumBenefits: required: - accum_Name - benefit_Code - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanAddedAccum.Plan_ID for this Added Accumulator. accum_Name: maxLength: 10 minLength: 1 type: string description: References the PlanAddedAccum.Accum_Name for this Added Accumulator. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the BenefitCodes.Benefit_Code for this Added Accumulator. additionalProperties: false PlanAddedAccumBenefitsListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanAddedAccumBenefits' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanAddedAccumBenefitsVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanAddedAccumBenefits' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanAddedAccumListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanAddedAccum' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanAddedAccumVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanAddedAccum' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanAuthPenalty: required: - penalty_Pct - planAuthPenalty_Key type: object properties: planAuthPenalty_Key: type: integer description: 'Unique identifier assigned to the Plan Auth Penalty. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 effective_Date: type: string description: Date when the penalty becomes effective. format: date-time nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true penalty: type: number description: Amount of the penalty that will applied. format: double nullable: true penalty_Max: type: number description: Maximum penalty that can be applied. format: double nullable: true penalty_Pct: type: boolean description: 'Indicates whether the penalty will be a percentage or fixed amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' penalty_Type: maxLength: 16 type: string description: 'Identifies the type of penalty: By Visit - adjudication will consider per Provider per day. By Occurrence - adjudication will consider the occurrence date of the claim.' nullable: true plan_ID: maxLength: 20 type: string description: References the Plans.Plan_ID value in parent table. nullable: true term_Date: type: string description: Date when the penalty is terminated. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanAuthPenaltyBenefit: required: - benefit_Code - planAuthPenalty_Key type: object properties: planAuthPenalty_Key: type: integer description: References the PlanAuthPenalty.PlanAuthPenalty_Key value in parent table. format: int32 benefit_Code: maxLength: 10 minLength: 1 type: string description: Identifies the Benefit Codes that are applied to the Auth Penalty. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanAuthPenaltyBenefitListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanAuthPenaltyBenefit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanAuthPenaltyBenefitVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanAuthPenaltyBenefit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanAuthPenaltyListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanAuthPenalty' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanAuthPenaltyVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanAuthPenalty' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenCodeDiagCode: required: - benefit_Code - diagnostic_Code_Type - exclude - from_Diag_Code - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefits.Plan_ID value in parent table. benefit_Code: maxLength: 50 minLength: 1 type: string description: References the PlanBenefits.Benefit_Code value in parent table. diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string description: 'Specifies the numbering system used for the selected Diagnosis Codes. Note: This field is marked as NOT NULL in the database and therefore required by the API.' from_Diag_Code: maxLength: 8 minLength: 1 type: string description: First Diagnosis Code for the specified range. This range allows the User to apply additional codes on top of the system-wide definition of codes for this benefit. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exclude: type: boolean description: 'Indicates whether the specified range of codes is Included or Excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.' thru_Diag_Code: maxLength: 8 type: string description: Last Diagnosis Code for the specified range. This range allows the User to apply additional codes on top of the system-wide definition of codes for this benefit. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanBenCodeDiagCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenCodeDiagCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenCodeDiagCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenCodeDiagCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenCodePlace: required: - benefit_Code - exclude - place_Code - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefits.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanBenefits.Benefit_Code value in parent table. place_Code: maxLength: 4 minLength: 1 type: string description: Specifies the place of service that the User wishes to either include or exclude as part of the benefit on top of the system-wide definition of the benefit. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exclude: type: boolean description: 'Indicates whether the specified code is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false PlanBenCodePlaceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenCodePlace' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenCodePlaceVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenCodePlace' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenCodeProcCode: required: - benefit_Code - exclude - from_Procedure - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefits.Plan_ID value in parent table. benefit_Code: maxLength: 50 minLength: 1 type: string description: References the PlanBenefits.Benefit_Code value in parent table. from_Procedure: maxLength: 8 minLength: 1 type: string description: First Procedure Code for the specified range. This range allows the User to apply additional codes on top of the system-wide definition of codes for this benefit. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exclude: type: boolean description: 'Indicates whether the specified range of codes is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_From_Procedure: maxLength: 8 type: string description: No longer in use. nullable: true override_Thru_Procedure: maxLength: 8 type: string description: No longer in use. nullable: true thru_Procedure: maxLength: 8 type: string description: Last Procedure Code for the specified range. This range allows the User to apply additional codes on top of the system-wide definition of codes for this benefit. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanBenCodeProcCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenCodeProcCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenCodeProcCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenCodeProcCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenCodeProviderType: required: - benefit_Code - exclude - plan_ID - provider_Type type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefits.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanBenefits.Benefit_Code value in parent table. provider_Type: maxLength: 10 minLength: 1 type: string description: Specifies the Provider type that the User wishes to either include or exclude as part of the benefit on top of the system-wide definition of the benefit. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exclude: type: boolean description: 'Indicates whether the specified code is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanBenCodeProviderTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenCodeProviderType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenCodeProviderTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenCodeProviderType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenCodeSpecialty: required: - benefit_Code - exclude - plan_ID - specialty_Code type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefits.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanBenefits.Benefit_Code value in parent table. specialty_Code: maxLength: 10 minLength: 1 type: string description: Specifies the Provider specialty that the User wishes to either include or exclude as part of the benefit on top of the system-wide definition of the benefit. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exclude: type: boolean description: 'Indicates whether the specified code is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanBenCodeSpecialtyListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenCodeSpecialty' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenCodeSpecialtyVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenCodeSpecialty' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitCascade: required: - cascade_Benefit_Code - parent_Benefit_Code - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: Unique identifier assigned to the Plan. parent_Benefit_Code: maxLength: 10 minLength: 1 type: string description: Originating Benefit Code of the cascading benefit. cascade_Benefit_Code: maxLength: 10 minLength: 1 type: string description: Target Benefit Code of the cascading benefit. additionalProperties: false PlanBenefitCascadeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenefitCascade' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitCascadeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenefitCascade' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitCluster: required: - benefit_Code - plan_ID - planBenefitCluster_Key type: object properties: planBenefitCluster_Key: type: integer description: 'Identity column for table PlanBenefitCluster Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 benefit_Code: maxLength: 10 minLength: 1 type: string description: Which Benefit Code is the base code for this Plan Benefit Cluster entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true multiTier_1: maxLength: 10 type: string description: First Multitier for the Benefit Code listed under this Plan Benefit Cluster nullable: true multiTier_2: maxLength: 10 type: string description: Second Multitier for the Benefit Code listed under this Plan Benefit Cluster nullable: true multiTier_3: maxLength: 10 type: string description: Third Multitier for the Benefit Code listed under this Plan Benefit Cluster nullable: true multiTier_4: maxLength: 10 type: string description: Fourth Multitier for the Benefit Code listed under this Plan Benefit Cluster nullable: true multiTier_5: maxLength: 10 type: string description: Fifth Multitier for the Benefit Code listed under this Plan Benefit Cluster nullable: true plan_ID: maxLength: 20 minLength: 1 type: string description: Which Plan this Plan Benefit Cluster belongs to update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false PlanBenefitClusterListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenefitCluster' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitClusterVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenefitCluster' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitLevel: required: - benefit_Code - benefit_Level - exclude - planBenefitLevel_Key type: object properties: planBenefitLevel_Key: type: integer description: 'Unique idenfitier assigned to the Plan Benefit Level. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 benefit_Code: maxLength: 50 minLength: 1 type: string description: References the PlanBenefits.Benefit_Code value in parent table. benefit_Level: maxLength: 32 minLength: 1 type: string description: 'Unique identifier assigned to the Plan Benefit Level: Age by Service Date - age of the Member by the service date of the claim. Age by Received Date - age of the Member by the received date of the claim. Relationship Code - relationship of the Member to the Subscriber. Months Enrolled in Plan - range of months the Member has been enrolled in the plan. Days Enrolled in Plan - range of days the Member has been enrolled in the plan. Network - network of the claim. Out of Network - claim is out of network. Billed Amount - range of billed amount of the service line. Modifier - modifier exists on the service line. Exact Modifier - modifier exists in the exact location on the service line. No Modifier - no modifier exists on the service line. Exclude Modifier - modifier does not exist on the service line. Exclude Exact Modifier - modifier does not exist in the exact location on the service line. Gender - biological sex of the Member. Billing Taxonomy - taxonomy of the billing Provider must be included in the taxonomy group. Rendering Taxonomy - taxonomy of the rendering Provider must be included in the taxonomy group. Service Facility Taxonomy - taxonomy of the facility Provider must be included in the taxonomy group. Procedure Category - procedure code on the service line must fall into the indicated procedure category. Procedure Cluster - procedure code on the service line must fall into the indicated procedure cluster. Provider Federal ID - federal ID of the claim''s Provider.' entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true exclude: type: boolean description: 'Indicates whether the specified code is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.' extra_Value1: maxLength: 128 type: string description: Additional value that may be associated with the Benefit Level. nullable: true extra_Value2: maxLength: 128 type: string description: Additional value that may be associated with the Benefit Level. nullable: true from_Value: maxLength: 128 type: string description: Initial value in the range of values. nullable: true plan_ID: maxLength: 20 type: string description: References the PlanBenefits.Plan_ID value in parent table. nullable: true thru_Value: maxLength: 128 type: string description: Final value in the range of values. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true value_Type: maxLength: 32 type: string description: Specifies the type or measure of the associated Benefit Level values. nullable: true additionalProperties: false PlanBenefitLevelListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenefitLevel' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitLevelVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenefitLevel' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitPBM: required: - benefit_Code - pbM_Type - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefits.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanBenefits.Benefit_Code value in parent table. pbM_Type: maxLength: 8 minLength: 1 type: string description: User-defined type of pharmacy benefit copay. This information is pulled into the Member SPD matrix on the Member screen. co_Pay_Amount: type: number description: Amount of Copay that the Member is responsible for. format: double nullable: true additionalProperties: false PlanBenefitPBMListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenefitPBM' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitPBMVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenefitPBM' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitRate: required: - benefit_Code - effective_Date - plan_ID - planBenefitRate_Key - rate - rate_Pct - rate_Type type: object properties: planBenefitRate_Key: type: integer description: 'Unique idenfiter assigned to the Plan Benefit Rate. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanBenefits.Benefit_Code value in parent table. effective_Date: type: string description: Date when the Rate becomes effective. format: date-time entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: This code is applied to any claim that utilizes the benefit rate. nullable: true network_ID: maxLength: 10 type: string description: Network ID associated with the Plan Benefit Rate nullable: true plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefits.Plan_ID value in parent table. rate: type: number description: 'This area will allow for a limit (dollar or percentage) of how much of the allowed amount can be paid out, per claim detail line, by the specific plan benefit. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: double rate_Max: type: number description: Max rate that can be paid out. format: double nullable: true rate_Max_Type: maxLength: 6 type: string description: 'Type of Benefit Level Maximum: Per Calendar Year - January 1st through December 31st. Per Plan Year - per plan year as defined by the Group.' nullable: true rate_Pct: type: boolean description: 'Indicates whether the Rate will be a percentage or fixed amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' rate_Type: maxLength: 6 minLength: 1 type: string description: 'Type of Benefit Rate: Per Service Line - rate is applied to each service line. Per Day - rate is applied per service date. Per Visit - rate is applied per service date per Provider.' term_Date: type: string description: Date when the Rate expires. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanBenefitRateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenefitRate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitRateVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenefitRate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefits: required: - always_Pay_In_Network - benefit_Code - coIns_In_To_Out - coIns_Out_To_In - coIns_Out_To_In_Limit - coverage_24Hour - covered - ded_In_To_Out - ded_Out_To_In - ded_Out_To_In_Limit - deductible_Before_CoPay - excluded - hospital_1stDay - ltC_Applies_To_Elimination_Period - ltC_Applies_To_WP - ltC_Apply_Inflation - ltC_Base_Benefit - ltC_Inflation_Benefit - ltC_Inflation_Compound - ltC_Shared_Benefit - ltC_Use_Benefit_DBA - ltC_Use_Benefit_Lifetime_Max - ltC_Use_Benefit_MBA - ltC_Use_Pct_Of_Benefit - maternity - occupational - ooP_In_To_Out - ooP_Out_To_In - ooP_Out_To_In_Limit - parent_Benefit - pcP_Only - plan_ID - rider - use_Plan_CoIns - use_Plan_Ded - use_Plan_Max - use_Plan_OOP type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: Unique identifier assigned to the Plan. benefit_Code: maxLength: 10 minLength: 1 type: string description: Unique identifier assigned to the Benefit. accident_Only: maxLength: 1 type: string description: 'Checking this option indicates that the benefit is covered only when services are rendered as the result of an accident. On the Claim Entry screen, there are options to that specify that a claim is the result of an accident. If a claim is processed against this Benefit Code without one of the accident options picked on the claim, the claim will automatically ''Deny'' or ''Pend'' based on the Ex Code defined on the VBA Control Panel.' nullable: true always_Pay_In_Network: type: boolean description: 'When checked, if the PlanBenefit_Override_Network_ID is filled out on companydata and the claim is currently out of network, change the Network ID to the PlanBenefit Override Network ID value. Note: This field is marked as NOT NULL in the database and therefore required by the API.' annual_Max: type: number description: Total annual amount that the Plan will pay both In Network and Out of Network. format: double nullable: true annual_Max_Member: type: number description: Total annual amount that the Member pays both In Network and Out of Network. format: double nullable: true annual_Max_Net: type: number description: Annual amount that the Plan will pay In Network. format: double nullable: true annual_Max_Net_Member: type: number description: Annual amount that the Member pays In Network. format: double nullable: true annual_Max_OON: type: number description: Annual amount that the Plan will pay Out of Network. format: double nullable: true annual_Max_OON_Member: type: number description: Annual amount that the Member pays Out of Network. format: double nullable: true coIns_In_To_Out: type: boolean description: 'Applies the In-Network Co-Insurance amount toward the satisfaction of the Out-of-Network Co-Insurance maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.' coIns_Max_Mem: type: number description: In Network Co-Insurance amount for the Family. format: double nullable: true coIns_Max_Net_Mem: type: number description: Total Co-Insurance amount for the Member. format: double nullable: true coIns_Max_Net_Sub: type: number description: Out of Network Co-Insurance amount for the Family. format: double nullable: true coIns_Max_OON_Mem: type: number description: Out of Network Co-Insurance amount for the Member. format: double nullable: true coIns_Max_OON_Sub: type: number description: In Network Co-Insurance amount for the Member. format: double nullable: true coIns_Max_Sub: type: number description: Maximum CoInsurance amount for the Family per plan year. format: double nullable: true coIns_Out_To_In: type: boolean description: 'Applies the Out-of-Network Co-Insurance amount toward the satisfaction of the In-Network Co-Insurance maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.' coIns_Out_To_In_Limit: type: boolean description: 'When active, this will let the system know to limit the amount of co-insurance that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.' coIns_Out_To_In_Limit_Max: type: number description: The max with which the co-insurance is limited by when CoIns_Out To In Limit is selected. format: double nullable: true coverage_24Hour: type: boolean description: 'This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.' covered: maxLength: 1 minLength: 1 type: string description: 'Identifies whether the Benefit Code is covered for this Plan. This can be populated from the ''Plan'' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.' covered_In_Net_Only: maxLength: 1 type: string description: 'Checking this option indicates that the Benefit is covered only when services are rendered by an In-Network provider. If a claim is processed against this Benefit Code as Out of Network, the claim will apply the “Covered In-Network Only“ Ex Code defined on the VBA Control Panel.' nullable: true ded_In_To_Out: type: boolean description: 'Applies the In-Network deductible amount toward the satisfaction of the Out-of-Network deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ded_Out_To_In: type: boolean description: 'Applies the Out-of-Network deductible amount toward the satisfaction of the In-Network deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ded_Out_To_In_Limit: type: boolean description: 'When active, this will let the system know to limit the amount of deductible that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ded_Out_To_In_Limit_Max: type: number description: The max with which the deducible is limited by when Ded_Out To In Limit is selected. format: double nullable: true deductible_Before_CoPay: type: boolean description: 'This flag determines if adjudication calculates the Deductible before the CoPay is calculated. Note: This field is marked as NOT NULL in the database and therefore required by the API.' effective_Date: type: string description: Date when the Benefit becomes effective on this plan. format: date-time nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true excluded: maxLength: 1 minLength: 1 type: string description: 'Identifies whether the Benefit Code is excluded for this Plan. This can be populated from the ''Plan'' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.' hospital_1stDay: type: boolean description: 'This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.' include_Amt_In_Plan: maxLength: 1 type: string description: 'Indicates that the Plan Benefit amount is included in the Plan level Maximum calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.' nullable: true include_CoIns_In_Plan: maxLength: 1 type: string description: 'Indicates that the Plan Benefit amount is included in the Plan level Co-Insurance calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.' nullable: true include_Ded_In_Plan: maxLength: 1 type: string description: 'Indicates that the Plan Benefit amount is included in the Plan level Deductible calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.' nullable: true include_OOP_In_Plan: maxLength: 1 type: string description: 'Indicates that the Plan Benefit amount is included in the Plan level Out of Pocket calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.' nullable: true ltC_Applies_To_Elimination_Period: type: boolean description: 'Indicates if this benefits applies to the Elimination Period for claims processed under this plan. This value would only apply if the Plan itself is configured with an Elimination Period. This indicator will be ON by default so that the user has to specifically exclude. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Applies_To_WP: type: boolean description: 'Indicates if this benefit applies to the waiting period. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Apply_Inflation: type: boolean description: 'Indicates it Inflation calculation should be applied Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Base_Benefit: type: boolean description: 'Not sure about this, but I think what I want is to have one benefit defined on any plan that has a LTC Plan_Type. You can only have one and must have one. This is like the STD or LTD benefit on disability. Its the benefit we use to do all the base benefit payment stuff. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Daily_Benefit: type: number description: This is the daily benefit amount format: double nullable: true ltC_Daily_Benefit_Range_From: type: number description: The start of the selection range for members taking this plan and choosing their daily benefit. format: double nullable: true ltC_Daily_Benefit_Range_Increment: type: number description: 'The increment of each option in the range between the from and thru. If empty, the member can manually select a value between the from / thru range.' format: double nullable: true ltC_Daily_Benefit_Range_Thru: type: number description: The end of the selection range for members taking this plan and choosing their daily benefit. format: double nullable: true ltC_Daily_Benefit_Type: maxLength: 32 type: string description: 'This is the type of daily benefit defined for this plan. The values are: A - a flat daily benefit enforced by the plan. B - member selected value utilizing the daily benefit range/increment settings.' nullable: true ltC_Inflation_Benefit: type: boolean description: 'identify that this is an inflation benefit. Would still use Covered/Rider to determine if the inflation offering is optional or not. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Inflation_Compound: type: boolean description: 'Indicates if the inflation interest is simple (0) or compunded (1). Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Inflation_Frequency: type: integer description: 'this is the value for the Inflation_Frequency_Type (i.e. 1 Year, 30 Days, 6 Months, etc.)' format: int32 nullable: true ltC_Inflation_Frequency_Start: maxLength: 32 type: string description: 'indicates when the Inflation_Frequency is calculated from: GROUP - Group Anniversary Enroll DIV - Division Anniversary Enroll MEMBER - Member Anniversary Enroll PLAN - Initial Plan Enroll' nullable: true ltC_Inflation_Frequency_Type: maxLength: 32 type: string description: 'Indicates the frequency of inflation increases. The values are: D - Days M - Months Y - Years' nullable: true ltC_Inflation_Limit: type: number description: 'This value is based on Inflation_Limit_Type. For A, this is the flat cap on inflation. For B, this is the multiple of Limit defined as a cap (i.e. 2 for 2x limit or 2.5 for 2.5x limit)' format: double nullable: true ltC_Inflation_Limit_Type: maxLength: 32 type: string description: 'the type of limit cap. This filed only shows if Inflation_Type = B. The 2 options are: A - Flat Cap B - Multipl of Limit' nullable: true ltC_Inflation_Pct: type: number description: This is the inflation value (i.e. 5% or 6%) format: double nullable: true ltC_Inflation_Type: maxLength: 32 type: string description: 'drop down list of inflation types that change options that can be filled in. The choices would be: A - Simple Inflation B - Inflation With Cap C - Inflation No Cap' nullable: true ltC_Lifetime_Max_Days_From: type: integer description: The selectable range of days the member can pick for calculations based on days. format: int32 nullable: true ltC_Lifetime_Max_Days_Thru: type: integer description: The selectable range of days the member can pick for calculations based on days. format: int32 nullable: true ltC_Lifetime_Max_From: type: number description: The low end range for member lifetime max selection. format: double nullable: true ltC_Lifetime_Max_Increment: type: number description: the increment of options the user can select within the max range. Empty value here means it is a free from entry of max between the range. format: double nullable: true ltC_Lifetime_Max_Thru: type: number description: the high end range for member lifetime max selection. format: double nullable: true ltC_Lifetime_Max_Type: maxLength: 32 type: string description: 'Lifetime Max calculation type and will dicatate the max rules applied. Valid values are: STANDARD - DBM x 365 days x Lifetime Max Years selected LMDAYS - DBM x Lifetime Max Days selected FLAT - Lifetime Max Amount selected and not based on calculation LMMONTHS - MBA x 12 Months x Lifetime Max Years selected' nullable: true ltC_Lifetime_Max_Years_From: type: integer description: the selectable range of years the member can pick for calculations based on years. format: int32 nullable: true ltC_Lifetime_Max_Years_Thru: type: integer description: the selectable range of years the member can pick for calculations based on years. format: int32 nullable: true ltC_Monthly_Benefit: type: number description: This is the monthly benefit amount format: double nullable: true ltC_Monthly_Benefit_Range_From: type: number description: The start of the selection range for members taking this plan and choosing their monthly benefit. format: double nullable: true ltC_Monthly_Benefit_Range_Increment: type: number description: 'The increment of each option in the range between the from and thru. If empty, the member can manually select a value between the from / thru range.' format: double nullable: true ltC_Monthly_Benefit_Range_Thru: type: number description: The end of the selection range for members taking this plan and choosing their monthly benefit. format: double nullable: true ltC_Monthly_Benefit_Type: maxLength: 32 type: string description: 'This is the type of monthly benefit defined for this plan. The values are: A - a flat monthly benefit enforced by the plan. B - member selected value utilizing the monthly benefit range/increment settings.' nullable: true ltC_Pct_Of_Benefit: type: number description: the pct the be calculated against the pct_of_benefit_code. format: double nullable: true ltC_Pct_Of_Benefit_Code: maxLength: 10 type: string description: This is the benefit code that this benefit will be a Pct of. nullable: true ltC_Shared_Benefit: type: boolean description: 'Indicates if this Benefit Code is shared across multiple members of the family AND can be used in Lifetime Max calculations to determine if the same benefit across multiple plans (same plan type) could apply together. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Use_Benefit_DBA: type: boolean description: 'Indicates if we should use this benefit DBA configuration rather than the Plan DBA. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Use_Benefit_Lifetime_Max: type: boolean description: 'This indicates if the PlanBenefit level LBM logic should be used rather thant he parent Plan LBM settings. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Use_Benefit_MBA: type: boolean description: 'Indicates if we should use this benefit MBA configuration rather than the Plan MBA. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Use_Benefit_Type: maxLength: 16 type: string description: This is an indicator for whether this PlanBenefit will utilize the Daily Benefit Amount or the Monthly Benefit Amount. nullable: true ltC_Use_Pct_Of_Benefit: type: boolean description: 'identifies that this benefit amount is calculated as a percent of another benefit Note: This field is marked as NOT NULL in the database and therefore required by the API.' lifetime_Max: type: number description: Total lifetime amount that the Plan will pay both In Network and Out of Network. format: double nullable: true lifetime_Max_Member: type: number description: Total lifetime amount that the Member pays both In Network and Out of Network. format: double nullable: true lifetime_Max_Net: type: number description: Lifetime amount that the Plan will pay In Network. format: double nullable: true lifetime_Max_Net_Member: type: number description: Lifetime amount that the Member pays In Network. format: double nullable: true lifetime_Max_OON: type: number description: Lifetime amount that the Plan will pay Out of Network. format: double nullable: true lifetime_Max_OON_Member: type: number description: Lifetime amount that the Member pays Out of Network. format: double nullable: true maternity: type: boolean description: 'This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.' member_Ded_OON: type: number description: Deductible amount for the Member Out of Network. format: double nullable: true member_Ded_PPO: type: number description: Deductible amount for the Member In Network. format: double nullable: true member_Deductible: type: number description: Total deductible amount for the Member both In Network and Out of Network. format: double nullable: true ooP_Calc_Option: maxLength: 8 type: string description: Formula used to calculate the Out-of-Pocket amounts. nullable: true ooP_In_To_Out: type: boolean description: 'Applies the In-Network Out-of-Pocket amount toward the satisfaction of the Out-of-Network Out-of-Pocket maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ooP_Max_Mem: type: number description: Total Out-of-Pocket amount for the Member. format: double nullable: true ooP_Max_Net_Mem: type: number description: Total Out-of-Pocket amount for the Member In Network. format: double nullable: true ooP_Max_Net_Sub: type: number description: Total Out-of-Pocket amount for the Family In Network. format: double nullable: true ooP_Max_OON_Mem: type: number description: Out-of-Pocket amount for the Member Out of Network. format: double nullable: true ooP_Max_OON_Sub: type: number description: Out-of-Pocket amount for the Family Out of Network. format: double nullable: true ooP_Max_Sub: type: number description: Total Out-of-Pocket amount for the Family. format: double nullable: true ooP_Out_To_In: type: boolean description: 'Applies the Out-of-Network Out-of-Pocket amount toward the satisfaction of the In-Network Out-of-Pocket maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ooP_Out_To_In_Limit: type: boolean description: 'When active, this will let the system know to limit the amount of out of pocket that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ooP_Out_To_In_Limit_Max: type: number description: The max with which the out of pocket is limited by when OOP_Out To In Limit is selected. format: double nullable: true occupational: type: boolean description: 'This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.' pcP_Only: type: boolean description: 'Indicates that the selected Benefit applies to Primary Care Physician only. If a claim is processed against this Benefit Code without a PCP, the claim will apply the “PCP Only“ Ex Code defined on the VBA Control Panel. Note: This field is marked as NOT NULL in the database and therefore required by the API.' parent_Benefit: type: boolean description: 'Identifies if this Benefit is a parent benefit for purposes of cascading benefits. Note: This field is marked as NOT NULL in the database and therefore required by the API.' pend_Ex_Code: maxLength: 6 type: string description: Assigns an Ex Code that can be applied to adjudicated Subscriber claims. nullable: true pend_Flag: maxLength: 1 type: string description: 'While active, the assigned Ex Code will be applied to any adjudicated Subscriber claims.' nullable: true rider: maxLength: 1 minLength: 1 type: string description: 'Identifies whether the Benefit Code is a rider for this Plan. This can be populated from the ''Plan'' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.' subscriber_Ded_OON: type: number description: Deductible amount for the Family Out of Network. format: double nullable: true subscriber_Ded_PPO: type: number description: Deductible amount for the Family In Network. format: double nullable: true subscriber_Deductible: type: number description: Total deductible amount for the Family both In Network and Out of Network. format: double nullable: true term_Date: type: string description: Date when the Benefit expires for this plan. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true use_Plan_CoIns: maxLength: 1 minLength: 1 type: string description: 'Indicates that the Plan Benefit Co-Insurance amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Plan_Ded: maxLength: 1 minLength: 1 type: string description: 'Indicates that the Plan Benefit Deductible amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Plan_Max: maxLength: 1 minLength: 1 type: string description: 'Indicates that the Plan Benefit Maximums will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_Plan_OOP: maxLength: 1 minLength: 1 type: string description: 'Indicates that the Plan Benefit Out of Pocket amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false PlanBenefitsDiagnosis: required: - benefit_Code - diagnostic_Code - diagnostic_Code_Type - ex_Code - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefits.Plan_ID value in parent table. benefit_Code: maxLength: 50 minLength: 1 type: string description: References the PlanBenefits.Benefit_Code value in parent table. diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string description: 'Specifies the numbering system used for the selected Diagnosis Codes. Note: This field is marked as NOT NULL in the database and therefore required by the API.' diagnostic_Code: maxLength: 8 minLength: 1 type: string description: First Diagnosis Code for the specified range. This allows the User to apply the specified Ex Code to any claims containing a diagnosis code within the defined range. diagnostic_Code_Thru: maxLength: 8 type: string description: Last Diagnosis Code for the specified range. This allows the User to apply the specified Ex Code to any claims containing a diagnosis code within the defined range. nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 minLength: 1 type: string description: This is the Ex Code that will be applied to any claims containing a diagnosis code within the defined range. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanBenefitsDiagnosisListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenefitsDiagnosis' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsDiagnosisVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenefitsDiagnosis' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenefits' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsModifiers: required: - benefit_Code - ex_Code - modifier - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefits.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanBenefits.Benefit_Code value in parent table. modifier: maxLength: 128 minLength: 1 type: string description: This allows the User to apply the specified Ex Code to any claims containing the selected modifier. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 minLength: 1 type: string description: This is the Ex Code that will be applied to any claims containing the selected modifier. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanBenefitsModifiersListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenefitsModifiers' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsModifiersVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenefitsModifiers' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsPlace: required: - benefit_Code - place_Code - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefits.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanBenefits.Benefit_Code value in parent table. place_Code: maxLength: 4 minLength: 1 type: string description: This allows the User to apply the speecified Ex Code to any claims containing the selected place code. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: This is the Ex Code that will be applied to any claims containing the selected place code. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanBenefitsPlaceAuth: required: - auth_Reqd - benefit_Code - place_Code - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefitsPlace.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanBenefitsPlace.Benefit_Code value in parent table. place_Code: maxLength: 4 minLength: 1 type: string description: References the PlanBenefitsPlace.Place_Code value in parent table. amount_Before_Auth: type: number description: Specifies the amount of the associated amount type that is allowed before requiring an authorization. format: double nullable: true amount_Type: maxLength: 16 type: string description: 'Specifies the amount type (Billed, Allowed, or Payable) that the ''Amount Before Auth'' rule will be tied to.' nullable: true auth_Reqd: maxLength: 1 minLength: 1 type: string description: 'Indicates whether an authorization is required for the selected place code. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true visits_Before_Auth: type: integer description: Specifies the number of visits allowed before an authorization is required. format: int32 nullable: true additionalProperties: false PlanBenefitsPlaceAuthListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenefitsPlaceAuth' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsPlaceAuthVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenefitsPlaceAuth' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsPlaceCoIns: required: - benefit_Code - co_Ins_Net_Pct - co_Ins_Pct - place_Code - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefitsPlace.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanBenefitsPlace.Benefit_Code value in parent table. place_Code: maxLength: 4 minLength: 1 type: string description: References the PlanBenefitsPlace.Place_Code value in parent table. co_Ins_Net_Pct: maxLength: 1 minLength: 1 type: string description: 'Indicates whether the In Network Co-Insurance amount is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.' co_Ins_Pct: maxLength: 1 minLength: 1 type: string description: 'Indicates whether the Out of Network Co-Insurance amount is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.' co_Insurance: type: number description: Out of Network Co-Insurance amount. format: double nullable: true co_Insurance_Net: type: number description: In Network Co-Insurance amount. format: double nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanBenefitsPlaceCoInsListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenefitsPlaceCoIns' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsPlaceCoInsVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenefitsPlaceCoIns' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsPlaceCoPay: required: - benefit_Code - copay_Amt_Net_OOP - copay_Amt_OOP - copay_Pct - copay_Pct_Net - place_Code - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefitsPlace.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanBenefitsPlace.Benefit_Code value in parent table. place_Code: maxLength: 4 minLength: 1 type: string description: References the PlanBenefitsPlace.Place_Code value in parent table. copay_Amt: type: number description: Out of Network Co-Pay amount. format: double nullable: true copay_Amt_Net: type: number description: In Network Co-Pay amount. format: double nullable: true copay_Amt_Net_OOP: type: boolean description: 'Indicates that the In Network Co-Pay will continue to be taken after the Out of Pocket has been met. Note: This field is marked as NOT NULL in the database and therefore required by the API.' copay_Amt_OOP: type: boolean description: 'Indicates that the Out of Network Co-Pay will continue to be taken after the Out of Pocket has been met. Note: This field is marked as NOT NULL in the database and therefore required by the API.' copay_Pct: maxLength: 1 minLength: 1 type: string description: 'Indicates whether the Out of Network Co-Pay amount is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.' copay_Pct_Net: maxLength: 1 minLength: 1 type: string description: 'Indicates whether the In Network Co-Pay amount is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.' copay_Per: maxLength: 1 type: string description: 'Indicates the frequency that Co-Pay is taken: 1. Day - per service date. 2. Occurrence - per occurrence date on the claim header. 3. Service - per service line. 4. Unit - per unit on the service line. 5. Visit - per day per Provider.' nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanBenefitsPlaceCoPayListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenefitsPlaceCoPay' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsPlaceCoPayVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenefitsPlaceCoPay' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsPlaceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenefitsPlace' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsPlaceVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenefitsPlace' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsProcedures: required: - benefit_Code - pend_Ex_Code - plan_ID - procedure_Code type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefitsPlace.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanBenefitsPlace.Benefit_Code value in parent table. procedure_Code: maxLength: 8 minLength: 1 type: string description: References the PlanBenefitsPlace.Place_Code value in parent table. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true pend_Ex_Code: maxLength: 6 minLength: 1 type: string description: Ex Code that will be applied to the designated range of procedure codes. procedure_Code_Thru: maxLength: 8 type: string description: End of the range of procedure codes that the selected Ex Code will apply to. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanBenefitsProceduresListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanBenefitsProcedures' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsProceduresVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenefitsProcedures' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanBenefitsVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanBenefits' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanCopy: type: object properties: benefits: type: boolean cascade: type: boolean capitation: type: boolean restrictions: type: boolean preEx: type: boolean addedAccum: type: boolean maximums: type: boolean pbmCoPay: type: boolean placeDetails: type: boolean placeAuth: type: boolean placeCoPay: type: boolean placeCoIns: type: boolean exCodeDetails: type: boolean exCodeProcedure: type: boolean exCodeDiagnosis: type: boolean exCodePlace: type: boolean context4Details: type: boolean context4Pricing: type: boolean authPenalty: type: boolean benefitLevel: type: boolean benefitRates: type: boolean idCodes: type: boolean exCodeModifiers: type: boolean originalPlanID: type: string nullable: true newPlanID: type: string nullable: true newPlanDescription: type: string nullable: true newPlanType: type: string nullable: true copyMode: type: integer format: int32 additionalProperties: false PlanDiagnosisAge: required: - diagnostic_Code_Type - from_Diag - plan_ID - planDiagnosisAge_Key - thru_Diag type: object properties: planDiagnosisAge_Key: type: integer description: 'Unique identifier for each Diagnosis Age rule. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 age_Range_Type: maxLength: 1 type: string description: 'Specifies whether the associated age range is in days, months, or years.' nullable: true age_Type: maxLength: 16 type: string description: 'Adjudication will apply the rule if the Patient falls outside of the specified range based upon the designated criteria: 1. Birth Date - age is specified by looking at the Patient''s day of birth. 2. End of Birth Month - age is specified based upon the full birth month. For example, if the Patient is turning 18 on September 12th, adjudication won''t consider the Patient to be 18 until October 1st. 3. Ignore Age - defauls the rule to only being based upon the diagnosis code.' nullable: true diagnostic_Code_Type: maxLength: 16 minLength: 1 type: string description: 'Specifies the numbering system used for the selected Diagnosis Codes. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: Specifies the Ex Code that will be applied based upon the designated criteria. nullable: true from_Age: type: integer description: Start of the range of Ages. format: int32 nullable: true from_Diag: maxLength: 8 minLength: 1 type: string description: Start of the range of Diagnosis Codes. plan_ID: maxLength: 20 minLength: 1 type: string description: References the Plans.Plan_ID value in parent table. thru_Age: type: integer description: End of the range of Ages. format: int32 nullable: true thru_Diag: maxLength: 8 minLength: 1 type: string description: End of the range of Diagnosis Codes. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanDiagnosisAgeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanDiagnosisAge' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanDiagnosisAgeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanDiagnosisAge' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanDisplay: required: - display_Type - plan_ID - planDisplay_Key type: object properties: planDisplay_Key: type: integer description: 'Unique identifier for each Plan Display value. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 display: maxLength: 512 type: string description: Allows the User to input text that will be tied to the chosen display type and can be exported to the User's designated ID card printer. nullable: true display_Type: maxLength: 32 minLength: 1 type: string description: Allows the User to choose which type of display they would like to add text for. These display types are defined from 'Display Types' within Plan Benefit Configuration. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true plan_ID: maxLength: 20 minLength: 1 type: string description: References the Plans.Plan_ID value in parent table. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanDisplayListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanDisplay' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanDisplayType: required: - display_Type type: object properties: display_Type: maxLength: 32 minLength: 1 type: string description: Allows the User to choose which type of display they would like to add text for. These display types are defined from 'Display Types' within Plan Benefit Configuration. description: maxLength: 512 type: string description: Allows the User to input text that will be tied to the chosen display type and can be exported to the User's designated ID card printer. nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanDisplayTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanDisplayType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanDisplayTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanDisplayType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanDisplayVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanDisplay' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanLineage: required: - description - plan_Lineage_ID type: object properties: plan_Lineage_ID: maxLength: 32 minLength: 1 type: string description: Unique identifier for each Plan Lineage configuration. This is used to group a set of ranked plans for Plan Lineage logic in VBASoftware and VBAGateway. description: maxLength: 256 minLength: 1 type: string description: The description of this Plan Lineage configuration. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanLineageDetail: required: - plan_ID - plan_Lineage_ID - plan_Rank - planLineageDetail_Key type: object properties: planLineageDetail_Key: type: integer description: 'Unique identifier for each Plan Lineage detail record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true plan_ID: maxLength: 20 minLength: 1 type: string description: Referneces the Plans.Plan_ID table and is the Plan ranked inside this plan lineage. plan_Lineage_ID: maxLength: 32 minLength: 1 type: string description: References the PlanLineage.Plan_Lineage_ID value in the parent table. plan_Rank: type: integer description: 'A required rank value that ranks each plan within this Plan_Lineage_ID. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanLineageDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanLineageDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanLineageDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanLineageDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanLineageListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanLineage' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanLineageVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanLineage' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanMapping: type: object properties: original_Plan_ID: type: string nullable: true mapped_Plan_ID: type: string nullable: true additionalProperties: false PlanMaximum: required: - benefit_Code - max_ID - member_Family - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanBenefits.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanBenefits.Benefit_Code value in parent table. max_ID: maxLength: 10 minLength: 1 type: string description: User-defined Identifier for the Maximum being entered. dental_Designation: maxLength: 1 type: string description: 'Specifies the Dental Designation options including Tooth, Quadrant, and Arch.' nullable: true effective_Date: type: string description: Having effective and term dates for the maximums allows for changes throughout the life of the plan. The dates defined reference to the date of service of the claim to determine which maximum applies. format: date-time nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true expire_Date: type: string description: Having effective and term dates for the maximums allows for changes throughout the life of the plan. The dates defined reference to the date of service of the claim to determine which maximum applies. format: date-time nullable: true frequency: type: integer description: 'The frequency defined here states how many of the Max Per apply for the Maximum line. This field has the logic of: Current minus Freq. A zero in this field will force the Maximum to calculate within the year, day, etc. defined in the Max Per. A 4 in this field will force the Maximum to calculate within 5 years, days, etc. defined in the Max Per.' format: int32 nullable: true max_Description: maxLength: 512 type: string description: Description identifying the Plan Maximum. nullable: true max_Ex_Code: maxLength: 6 type: string description: Each maximum needs and Ex Code defined for explanation during adjudication and for Remittance and EOB's. A denial Ex Code can only be used Visit Maximums as payable type Maximums can have partially paid lines. A denial code on at claim detail line that should be partially paid will result in the entire line being denied and the Maximum not being fulfilled. nullable: true max_Payable_Ex_Code: maxLength: 6 type: string description: Used for dollar maximums. The Ex Code in field 11 would be an informational code which allows the amount over the max to roll to the next line and apply the Denial Ex Code. nullable: true max_Per: maxLength: 1 type: string description: 'Defines the timeframe that applies to the Maximum: Day - per service date. Month - per every 30 or 31 days. Calendar Month - per calendar month in which the services were rendered. Calendar Year - per calendar year in which the services were rendered. Plan Year - per plan year as defined for the Member. Lifetime - per lifetime. Occurrence - per occurrence date on the claim header. Birth Date Year - per year defined by the Member''s date of birth. Visit - per service date per Provider.' nullable: true max_Sequence: type: integer description: Each Maximum needs to be sequenced in order for adjudication to determine which Maximum line should apply first. format: int32 nullable: true max_Type: maxLength: 1 type: string description: 'Indicates the type of Maximum: Visits - per service date. Svc Count - per units on service line. Payable Amount - payable amounts from claims. Co-pay Amount - co-pay amounts from claims. Co-Ins Amount - co-ins amounts from claims. Deductible Amount - deductible amounts from claims. Occurrence Payable - payable amount per occurrence date. Occurrence - per occurrence date on the claim header. Svc Count_Payable - payable amount on the service line divided by the number of units on the claim. This will pay the amount per unit for the number of units that are allowed by the rule.' nullable: true max_Type_Net: maxLength: 1 type: string description: Indicates whether both In and/or Out of Network benefits apply. nullable: true member_Family: maxLength: 1 minLength: 1 type: string description: 'Indicates whether the Maximum applies to the Family or each Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.' quantity: type: number description: Defines the dollar or count quantity that should apply to the Maximum. format: double nullable: true subscriber_Reimbursement: type: boolean description: 'Checking this box indicates that this benefit maximum represents a maximum that must be paid out in full regardless of the billed amount on the claim or allowable. A new claim will be created to pay any difference to the Subscriber. Note: The database will apply a default value of `False` for this field if a value is not provided.' nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true visit_Criteria: type: integer description: No longer in use. format: int32 nullable: true additionalProperties: false PlanMaximumBenefit: required: - benefit_Code - included_Benefit_Code - max_ID - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanMaximum.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanMaximum.Benefit_Code value in parent table. max_ID: maxLength: 10 minLength: 1 type: string description: References the PlanMaximum.Max_ID value in the parent table. included_Benefit_Code: maxLength: 20 minLength: 1 type: string description: Additional Benefit Code included in the Maximum. additionalProperties: false PlanMaximumBenefitListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanMaximumBenefit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanMaximumBenefitVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanMaximumBenefit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanMaximumListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanMaximum' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanMaximumProcedure: required: - benefit_Code - from_Procedure - max_ID - plan_ID - procedure_Code1 - procedure_Code2 - thru_Procedure type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanMaximum.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanMaximum.Benefit_Code value in parent table. max_ID: maxLength: 10 minLength: 1 type: string description: References the PlanMaximum.Max_ID value in the parent table. from_Procedure: maxLength: 8 minLength: 1 type: string description: Beginning of the range of procedure codes that are applied to the Plan Maximum. entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true procedure_Code1: type: boolean description: 'Indicates whether the Procedure Code range applies to the primary procedure on any claim that this maximum is applied to. Note: This field is marked as NOT NULL in the database and therefore required by the API.' procedure_Code2: type: boolean description: 'Indicates whether the Procedure Code range applies to the secondary procedure on any claim that this maximum is appled to. Note: This field is marked as NOT NULL in the database and therefore required by the API.' thru_Procedure: maxLength: 8 minLength: 1 type: string description: End of the range of procedure codes that are applied to the Plan Maximum. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanMaximumProcedureListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanMaximumProcedure' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanMaximumProcedureVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanMaximumProcedure' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanMaximumTooth: required: - benefit_Code - max_ID - plan_ID - tooth_Number type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the PlanMaximum.Plan_ID value in parent table. benefit_Code: maxLength: 10 minLength: 1 type: string description: References the PlanMaximum.Benefit_Code value in parent table. max_ID: maxLength: 10 minLength: 1 type: string description: References the PlanMaximum.Max_ID value in the parent table. tooth_Number: type: integer description: Defines each tooth to include in the Maximum format: int32 additionalProperties: false PlanMaximumToothListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanMaximumTooth' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanMaximumToothVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanMaximumTooth' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanMaximumVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanMaximum' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanModifier: required: - apply_OON - apply_UC - effective_Date - modifier - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the Plans.Plan_ID value in parent table. modifier: maxLength: 8 minLength: 1 type: string description: Identifies the modifier that this rule applies to. effective_Date: type: string description: 'Date when the modifier rule becomes effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time apply_OON: type: boolean description: 'Indicates whether the modifier fee applies to Out of Network claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.' apply_UC: type: boolean description: 'Indicates whether the modifier fee is applied to Usual and Customary claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true fee_Percent: type: number description: Fee amount to be associated with the selected modifier. format: double nullable: true term_Date: type: string description: Date when the modifier rule is no longer effective. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanModifierListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanModifier' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanModifierVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanModifier' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanPreEx: required: - coverage_Type - plan_ID type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: References the Plans.Plan_ID value in parent table. coverage_Type: maxLength: 32 minLength: 1 type: string description: 'Coverage type, based on enrollment, that will be applied by the pre-existing condition.' disclosed_Ex_Code: maxLength: 6 type: string description: ExCode applied to this PlanPreEx disclosure. nullable: true disclosed_From_Range: type: integer description: Holds the value of the lower bound of a range defined for disclosed pre-existing entry. format: int32 nullable: true disclosed_Pre_Ex_Amount: type: number description: 'Amount allowed before a pend/deny on a pre-ex claim detail line, use in conjunction with Disclosed_Ex_Code.' format: double nullable: true disclosed_Range_Type: maxLength: 16 type: string description: 'Defines the type of range used with the bounds of the disclosed range. D = Days, M = Months.' nullable: true disclosed_Thru_Range: type: integer description: Holds the value of the upper bound of a range defined for disclosed pre-existing entry. format: int32 nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: Ex Code associated with the pre-existing condition. nullable: true from_Range: type: integer description: Beginning of the duration range that the pre-existing Conditon will apply to. format: int32 nullable: true pre_Ex_Amount: type: number description: Dollar amount that will be applied by the pre-existing condition before pending or denying claims. format: double nullable: true range_Type: maxLength: 16 type: string description: Unit of time used to measure the pre-existing Condition duration. Limited to units of either months or days. nullable: true thru_Range: type: integer description: End of the duration range that the pre-existing Conditon will apply to. format: int32 nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanPreExListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanPreEx' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanPreExVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanPreEx' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanProcedureAge: required: - ex_Code - from_Age - from_Procedure - plan_ID - procedureAgeKey - thru_Age - thru_Procedure type: object properties: procedureAgeKey: type: integer description: 'Unique identifier for each Procedure Age rule. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 age_Range_Type: maxLength: 1 type: string description: 'Unit of time used to measure the age duration. Defined by days, months, or years.' nullable: true age_Type: maxLength: 16 type: string description: 'Birth Date'', ''End of Birth Month'', or ''Ignore Age''.' nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 minLength: 1 type: string description: Ex Code associated with the age restriction. The selected Ex Code will apply to ages outside of the defined range. from_Age: type: integer description: 'Beginning of the range of acceptable ages. The selected Ex Code will apply to ages outside of the defined range. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 from_Procedure: maxLength: 8 minLength: 1 type: string description: Beginning of the range of associated procedure codes. plan_ID: maxLength: 20 minLength: 1 type: string description: References the Plans.Plan_ID value in parent table. thru_Age: type: integer description: 'Ending of the range of acceptable ages. The selected Ex Code will apply to ages outside of the defined range. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 thru_Procedure: maxLength: 8 minLength: 1 type: string description: End of the range of associated procedure codes. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanProcedureAgeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanProcedureAge' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanProcedureAgeModifier: required: - no_Modifier - planProcedureAgeModifier_Key - procedureAgeKey type: object properties: planProcedureAgeModifier_Key: type: integer description: 'Unique identifier for each Procedure Age Modifier rule. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true modifier1: maxLength: 8 type: string description: The first modifier being applied to the age restriction. nullable: true modifier2: maxLength: 8 type: string description: The second modifier being applied to the age restriction. nullable: true modifier3: maxLength: 8 type: string description: The third modifier being applied to the age restriction. nullable: true modifier4: maxLength: 8 type: string description: The fourth modifier being applied to the age restriction. nullable: true no_Modifier: type: boolean description: 'Identifies that the age restriction has no modifier. Note: This field is marked as NOT NULL in the database and therefore required by the API.' procedureAgeKey: type: integer description: 'References the PlanProcedureAge.PlanProcedureAge_Key value in parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanProcedureAgeModifierListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanProcedureAgeModifier' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanProcedureAgeModifierVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanProcedureAgeModifier' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanProcedureAgeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanProcedureAge' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanRelationshipAge: required: - ex_Code - from_Age - plan_ID - planRelationshipAge_Key - relate_Code - thru_Age type: object properties: planRelationshipAge_Key: type: integer description: 'Unique identifier for each Relationship Age rule. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 age_Type: maxLength: 16 type: string description: Birth Date' or 'End of Birth Month' nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 minLength: 1 type: string description: Ex Code associated with the age restriction. The selected Ex Code will apply to ages outside of the defined range. from_Age: type: integer description: 'Beginning of the range of acceptable ages. The selected Ex Code will apply to ages outside of the defined range. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 plan_ID: maxLength: 20 minLength: 1 type: string description: References the Plans.Plan_ID value in parent table. relate_Code: maxLength: 8 minLength: 1 type: string description: Code that identifies the relationship associated with the age restriction. thru_Age: type: integer description: 'Ending of the range of acceptable ages. The selected Ex Code will apply to ages outside of the defined range. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PlanRelationshipAgeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanRelationshipAge' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanRelationshipAgeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanRelationshipAge' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanType: required: - capitated - claims - dental - disc_Fee - discountCard - encounters - hra - hsa - indemnity - lifeADD - ltc - ltd - medical - misc - pay_As_You_Go - pension - pharmacy - plan_Type - print_On_ID - section125 - std - tier_Required - vision type: object properties: plan_Type: maxLength: 6 minLength: 1 type: string description: 'Unique identifier for each plan type that Identifies the Type of Plan (medical, dental, etc.).' capitated: type: boolean description: 'Indicates whether the associated plan should be capitated. Note: This field is marked as NOT NULL in the database and therefore required by the API.' claims: type: boolean description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' dental: type: boolean description: 'Indicates whether the specified plan type is a Dental Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 50 type: string description: A description area used to provider more detail about the plan type. nullable: true disc_Fee: type: boolean description: 'Indicates whether the specified plan type is associated with a Discount Fee. Note: This field is marked as NOT NULL in the database and therefore required by the API.' discountCard: type: boolean description: 'Indicates whether the specified plan type is a associated with a discount card. Note: This field is marked as NOT NULL in the database and therefore required by the API.' encounters: type: boolean description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true hipaA_Code: maxLength: 8 type: string description: HIPAA Code associated with the specified plan type. nullable: true hra: type: boolean description: 'Indicates whether the specified plan type is a HRA Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' hsa: type: boolean description: 'Indicates whether the specified plan type is a HSA Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' iD_Card_Description: maxLength: 8 type: string description: Shortened description of the plan type that is used to print on ID cards. nullable: true indemnity: type: boolean description: 'Indicates whether the specified plan type is an Indemnity Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltc: type: boolean description: 'Indicates if this plan type is a LTC plan type. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltd: type: boolean description: 'Indicates whether the specified plan type is a Long-Term Disability Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' lifeADD: type: boolean description: 'Indicates whether the specified plan type is a Life/ADD Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' medical: type: boolean description: 'Indicates whether the specified plan type is a Medical Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' misc: type: boolean description: Indicates if this plan type is a miscellaneous plan type. pay_As_You_Go: type: boolean description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' pension: type: boolean description: 'Indicates if this plan type is a Pension plan type. Note: This field is marked as NOT NULL in the database and therefore required by the API.' pharmacy: type: boolean description: 'Indicates whether the specified plan type is a Pharmacy Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' print_On_ID: type: boolean description: 'Indicates whether the specified plan type should be printed on ID cards. Note: This field is marked as NOT NULL in the database and therefore required by the API.' std: type: boolean description: 'Indicates whether the specified plan type is a Short-Term Disability Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' section125: type: boolean description: 'Indicates whether the specified plan type is a Section 125 Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' tier_Required: type: boolean description: 'This flag indicates Tier is a required field when updating an enrollment Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true vision: type: boolean description: 'Indicates whether the specified plan type is a Vision Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false PlanTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PlanType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlanTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PlanType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Plans: required: - auto_Create_Flex - capitated - coIns_In_To_Out - coIns_Out_To_In - coIns_Out_To_In_Limit - context4_PlanPriceNotGreaterBilledFg - ded_In_To_Out - ded_Out_To_In - ded_Out_To_In_Limit - family_Level_Co_Ins - family_Level_Ded - family_Level_OOP - flex_Advance_Fund - ltC_Apply_Elimination_Period - ltC_Apply_Waiver_Of_Premium - ltC_Elimination_Period_Per_Claim - ltC_Lifetime_Max_Joint_Policy - ooP_In_To_Out - ooP_Out_To_In - ooP_Out_To_In_Limit - plan_ID - remove_Member_Amount_Edit - use_COB_Savings type: object properties: plan_ID: maxLength: 20 minLength: 1 type: string description: Unique identifier assigned to the Plan. annual_Max: type: number description: Total In-Network and Out of Network annual maximum the plan will pay out for the Familiy. format: double nullable: true annual_Max_Net: type: number description: In-Network annual maximum that the plan will pay out for the Familiy. format: double nullable: true annual_Max_OON: type: number description: Out of Network annual maximum that the plan will pay out for the Familiy. format: double nullable: true auto_Create_Flex: type: boolean description: 'Indicates if this plan allows auto-creation of Flex claims based on Group level configuration for flex auto-creation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' cobrA_Plan_Type_Desc: maxLength: 20 type: string description: Used for custom reporting and information. nullable: true coB_Savings_Max: type: number description: Indicates the maximum amount that can be held in COB savings. format: double nullable: true coB_Type: maxLength: 16 type: string description: Indicates the type of COB to be used with the selected plan. nullable: true capitated: type: boolean description: 'No longer in use. All captiation logic and processing now resides in the capitation tables. Note: This field is marked as NOT NULL in the database and therefore required by the API.' cash_Value_Default: type: integer description: Default cash value when Policy & Forfeiture is used in enrollment. format: int32 nullable: true coIns_In_To_Out: type: boolean description: 'Indicates whether In-Network Coinsurance amounts apply toward the satisfaction of Out of Network amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.' coIns_Max_Mem: type: number description: In Network Co-Insurance amount for the Family. format: double nullable: true coIns_Max_Net_Mem: type: number description: Total Co-Insurance amount for the Member. format: double nullable: true coIns_Max_Net_Sub: type: number description: Out of Network Co-Insurance amount for the Family. format: double nullable: true coIns_Max_OON_Mem: type: number description: Out of Network Co-Insurance amount for the Member. format: double nullable: true coIns_Max_OON_Sub: type: number description: In Network Co-Insurance amount for the Member. format: double nullable: true coIns_Max_Sub: type: number description: Total Co-Insurance amount for the Family. format: double nullable: true coIns_Out_To_In: type: boolean description: 'Indicates whether Out of Network CoInsurance amounts apply toward the satisfaction of the In-Network amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.' coIns_Out_To_In_Limit: type: boolean description: 'When active, this will let the system know to limit the amount of co-insurance that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.' coIns_Out_To_In_Limit_Max: type: number description: The max with which the co-insurance is limited by when CoIns_Out To In Limit is selected. format: double nullable: true context4_ClmUcrPct: type: integer description: Claim UCR percentage provided by Context. Required for Context claim edits and repricing. format: int32 nullable: true context4_ClmUcrPct_OON: type: integer description: Out of network claim UCR percentage provided by context. Required for Context claim edits and repricing. format: int32 nullable: true context4_FeeSelector: maxLength: 8 type: string description: Fee Selector provided by Context. Required for Context claim edits and repricing. nullable: true context4_FeeSelector_OON: maxLength: 8 type: string description: Out of network fee selector provided by context. Required for Context claim edits and repricing. nullable: true context4_MedicarePct: type: integer description: Medicare percentage provided by Context. Required for Context claim edits and repricing. format: int32 nullable: true context4_MedicarePct_OON: type: integer description: Out of network Medicare percentage provided by context. Required for Context claim edits and repricing. format: int32 nullable: true context4_Password: maxLength: 128 type: string description: Password provided by Context. Required for Context claim edits and repricing. nullable: true context4_PayorType: maxLength: 8 type: string description: Payor type provided by context. Required for Context claim edits and repricing. nullable: true context4_PayorType_OON: maxLength: 8 type: string description: Out of network Payor type provided by context. Required for Context claim edits and repricing. nullable: true context4_PctOfChg: type: integer description: Percentage of change provided by context. Required for Context claim edits and repricing. format: int32 nullable: true context4_PctOfChg_OON: type: integer description: Out of network percentage of change provided by context. Required for Context claim edits and repricing. format: int32 nullable: true context4_PlanPriceNotGreaterBilledFg: type: boolean description: 'When using Context4, the Plan Price is never allowed to exceed the Billed Price, it''ll set it to the Billed Price. Note: This field is marked as NOT NULL in the database and therefore required by the API.' context4_UserID: maxLength: 128 type: string description: User ID provided by Context. Required for Context claim edits and repricing. nullable: true context4_WebURI: maxLength: 256 type: string description: URL provided by Context. Required for Context claim edits and repricing. nullable: true context4_WebURI_Delete: maxLength: 256 type: string description: URL delete provided by Context. Required for Context claim edits and repricing. nullable: true currency_ID: maxLength: 16 type: string description: Indicates the currency being used. nullable: true ded_In_To_Out: type: boolean description: 'Indicates whether In-Network Deductible amounts apply toward the satisfaction of Out of Network amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ded_Out_To_In: type: boolean description: 'Indicates whether Out of Network Deductible amounts apply toward the satisfaction of In-Network amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ded_Out_To_In_Limit: type: boolean description: 'When active, this will let the system know to limit the amount of deductible that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ded_Out_To_In_Limit_Max: type: number description: The max with which the deducible is limited by when Ded_Out To In Limit is selected. format: double nullable: true description: maxLength: 50 type: string description: A short description of the associated plan. nullable: true entry_Date: type: string description: Date when the record was added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true extended_Term_Default: type: integer description: Deault extended term value assigned in Policy & Forfeiture when used in enrollment. format: int32 nullable: true family_Level_Co_Ins: type: boolean description: 'Specifies that the number of Member level Coinsurance amounts should be used to satisfy the Family level Coinsurance amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' family_Level_Co_Ins_Member: type: integer description: Number of Members that must satisfy the Member level deductible before the Family level amount is considered met. format: int32 nullable: true family_Level_Ded: type: boolean description: 'Specifies that the number of Member level deductible amounts should be used to satisfy the Family level deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.' family_Level_Ded_Member: type: integer description: Number of Members that must satisfy the Member level deductible before the Family level amount is considered met. format: int32 nullable: true family_Level_OOP: type: boolean description: 'Specifies that the number of Member level Out of Pocket amounts should be used to satisfy the Family level Out of Pocket amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' family_Level_OOP_Member: type: integer description: Number of Members that must satisfy the Member level Out of Pocket before the Family level Out of Pocket is considered met. format: int32 nullable: true flex_Advance_Fund: type: boolean description: 'Information field used in reporting to identify this plan as Flex Advance Fund. Note: This field is marked as NOT NULL in the database and therefore required by the API.' flex_Type: maxLength: 16 type: string description: Indicates what type of Flex account to be associated with the plan. nullable: true forfeiture_Status_Default: maxLength: 32 type: string description: Default forfeiture status assigned when Policy & Forteiture is used in enrollment. nullable: true illness_Ex_Code: maxLength: 8 type: string description: Ex Code associated with the illness waiting period. nullable: true illness_Waiting_Period: type: integer description: Waiting Period after an illness for Disability plans to start coverage. format: int32 nullable: true include_Waiting_Period: type: boolean description: Indicates whether the Disability plan includes a waiting period. nullable: true injury_Ex_Code: maxLength: 8 type: string description: Ex Code associated with the injury waiting period. nullable: true injury_Waiting_Period: type: integer description: Waiting Period after an injury for Disability plans to start coverage. format: int32 nullable: true ltC_Apply_Elimination_Period: type: boolean description: 'Indicates if this Plan has Elimination Period rules. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Apply_Waiver_Of_Premium: type: boolean description: 'Indicates if Waiver of Premium rules should apply for this plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Daily_Benefit: type: number description: This is the daily benefit amount format: double nullable: true ltC_Daily_Benefit_Range_From: type: number description: The start of the selection range for members taking this plan and choosing their daily benefit. format: double nullable: true ltC_Daily_Benefit_Range_Increment: type: number description: 'The increment of each option in the range between the from and thru. If empty, the member can manually select a value between the from / thru range.' format: double nullable: true ltC_Daily_Benefit_Range_Thru: type: number description: The end of the selection range for members taking this plan and choosing their daily benefit. format: double nullable: true ltC_Daily_Benefit_Type: maxLength: 32 type: string description: 'This is the type of daily benefit defined for this plan. The values are: A - a flat daily benefit enforced by the plan. B - member selected value utilizing the daily benefit range/increment settings.' nullable: true ltC_Elimination_Period: type: integer description: This is the elimination period value based on Elimination_Period_Type. format: int32 nullable: true ltC_Elimination_Period_Per_Claim: type: boolean description: 'Indicates if the elimination period is per claim. By default the elimination period is per plan/policy. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Elimination_Period_Type: maxLength: 32 type: string description: 'This is the type of Elimination Period rule to apply for this Plan. Values are: A - Calendar Days B - Service Days C - Special Service Days (one day equals a week of elimination period)' nullable: true ltC_Lifetime_Max_Days_From: type: integer description: The selectable range of days the member can pick for calculations based on days. format: int32 nullable: true ltC_Lifetime_Max_Days_Thru: type: integer description: The selectable range of days the member can pick for calculations based on days. format: int32 nullable: true ltC_Lifetime_Max_From: type: number description: The low end range for member lifetime max selection. format: double nullable: true ltC_Lifetime_Max_Increment: type: number description: The increment of options the user can select within the max range. Empty value here means it is a free from entry of max between the range. format: double nullable: true ltC_Lifetime_Max_Joint_Policy: type: boolean description: 'Indicates if plans of the same plan type, and both flagged as joint policy, can share a "Total" lifetime max between both plans as long as both plans have selected a shared benefit. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ltC_Lifetime_Max_Thru: type: number description: The high end range for member lifetime max selection. format: double nullable: true ltC_Lifetime_Max_Type: maxLength: 32 type: string description: 'Lifetime Max calculation type and will dicatate the max rules applied. Valid values are: STANDARD - DBM x 365 days x Lifetime Max Years selected LMDAYS - DBM x Lifetime Max Days selected FLAT - Lifetime Max Amount selected and not based on calculation LMMONTHS - MBA x 12 Months x Lifetime Max Years selected' nullable: true ltC_Lifetime_Max_Years_From: type: integer description: the selectable range of years the member can pick for calculations based on years. format: int32 nullable: true ltC_Lifetime_Max_Years_Thru: type: integer description: The selectable range of years the member can pick for calculations based on years. format: int32 nullable: true ltC_Monthly_Benefit: type: number description: This is the monthly benefit amount format: double nullable: true ltC_Monthly_Benefit_Range_From: type: number description: The start of the selection range for members taking this plan and choosing their monthly benefit. format: double nullable: true ltC_Monthly_Benefit_Range_Increment: type: number description: 'The increment of each option in the range between the from and thru. If empty, the member can manually select a value between the from / thru range.' format: double nullable: true ltC_Monthly_Benefit_Range_Thru: type: number description: The end of the selection range for members taking this plan and choosing their monthly benefit. format: double nullable: true ltC_Monthly_Benefit_Type: maxLength: 32 type: string description: 'This is the type of monthly benefit defined for this plan. The values are: A - a flat monthly benefit enforced by the plan. B - member selected value utilizing the monthly benefit range/increment settings.' nullable: true ltC_Waiver_Of_Premium_Type: maxLength: 32 type: string description: 'This is the type/rules for LTC waiver of premium. Current Values are: A - 1st day of following month B - day of eligibility approval C - joint waiver D - survivorship waiver' nullable: true lifetime_Max: type: number description: Total lifetime amount that the Plan will pay both In Network and Out of Network for the Familiy. format: double nullable: true lifetime_Max_Net: type: number description: Lifetime amount that the Plan will pay In Network for the Familiy. format: double nullable: true lifetime_Max_OON: type: number description: Lifetime amount that the Plan will pay Out of Network for the Familiy. format: double nullable: true maturity_Age: type: integer description: Specifies the required age for maturity of policy inside enrollment. format: int32 nullable: true maturity_Age_Type: maxLength: 8 type: string description: Defines the age type for maturity based upon birth date or anniversary of enrollment. nullable: true max_Disability_Weeks: type: integer description: Maximum number of weeks the specified Plan will pay Disability. format: int32 nullable: true max_Includes_Waiting_Period: type: boolean description: Indicates whether the waiting period is included in the Max Disability Weeks. nullable: true mem_Ded_Credit: type: number description: Total deductible amount to be credited back to each Member during adjudication. format: double nullable: true mem_Ded_Credit_OON: type: number description: Out of Network deductible amount to be credited back to each Member during adjudication. format: double nullable: true mem_Ded_Credit_PPO: type: number description: In-Network deductible amount to be credited back to each Member during adjudication. format: double nullable: true member_Annual_Max: type: number description: Total In-Network and Out of Network annual maximum the plan will pay out per Member. format: double nullable: true member_Annual_Max_Net: type: number description: In-Network annual maximum that the plan will pay out per Member. format: double nullable: true member_Annual_Max_OON: type: number description: Out of Network annual maximum that the plan will pay out per Member. format: double nullable: true member_Ded_OON: type: number description: Deductible amount for the Member Out of Network. format: double nullable: true member_Ded_PPO: type: number description: Deductible amount for the Member In Network. format: double nullable: true member_Deductible: type: number description: Total deductible amount for the Member both In Network and Out of Network. format: double nullable: true member_Lifetime_Max: type: number description: Total In-Network and Out of Network lifetime maximum that the plan will pay out per Member. format: double nullable: true member_Lifetime_Max_Net: type: number description: In-Network lifetime maximum that the plan will pay out per Member. format: double nullable: true member_Lifetime_Max_OON: type: number description: Out of Network lifetime that the plan will pay out per Member. format: double nullable: true ooP_Calc_Option: maxLength: 8 type: string description: Formula used to calculate Out of Pocket amounts. nullable: true ooP_In_To_Out: type: boolean description: 'Indicates whether In-Network Out of Pocket amounts apply toward the satisfaction of Out of Network amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ooP_Max_Mem: type: number description: Total In-Network and Out of Network Out of Pocket maximum for the Member. format: double nullable: true ooP_Max_Net_Mem: type: number description: In-Network Out of Pocket maximum for the Member. format: double nullable: true ooP_Max_Net_Sub: type: number description: In-Network Out of Pocket maximum for the Family. format: double nullable: true ooP_Max_OON_Mem: type: number description: Out of Network Out of Pocket for the Member. format: double nullable: true ooP_Max_OON_Sub: type: number description: Out of Network Out of Pocket for the Family. format: double nullable: true ooP_Max_Sub: type: number description: Total In-Network and Out of Network Out of Pocket maximum for the Family. format: double nullable: true ooP_Out_To_In: type: boolean description: 'Indicates whether Out of Network Out of Pocket amounts apply toward the satisfaction of In-Network amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ooP_Out_To_In_Limit: type: boolean description: 'When active, this will let the system know to limit the amount of out of pocket that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.' ooP_Out_To_In_Limit_Max: type: number description: The max with which the out of pocket is limited by when OOP_Out To In Limit is selected. format: double nullable: true payment_Interval: type: integer description: Payment Interval or frequency for Disability plans. format: int32 nullable: true payor_ID: maxLength: 20 type: string description: No longer in use. nullable: true pend_Ex_Code: maxLength: 6 type: string description: Identifies the Ex Code that will be applied based upon the Pend_Flag field. nullable: true pend_Flag: maxLength: 1 type: string description: 'Specifies if an Ex Code will be assigned, which will apply to all claims adjudicated for this plan. The Ex Code can be an informational, denial, or pend code. All ExCodes impact adjudication.' nullable: true plan_Document_URL: maxLength: 512 type: string description: Used for custom reporting and information. nullable: true plan_Type: maxLength: 6 type: string description: 'Identifies the Type of Plan (medical, dental, etc.). Keep in mind that Accumulators are tied to ''Plan Type'' not the plan itself.' nullable: true policy_Forfeiture_Grace_Period: type: integer description: Length of the grace period. format: int32 nullable: true policy_Forfeiture_Grace_Period_Type: maxLength: 1 type: string description: Defines the type of grace period. Restricted to units of days. nullable: true policy_Status_Default: maxLength: 32 type: string description: Default policy status assigned when Policy & Forteiture is used in enrollment. nullable: true preEx_Ex_Code: maxLength: 8 type: string description: Identifies the Ex Code that will be applied to disability claims falling within the provided range. nullable: true preEx_From: type: integer description: No longer in use. Pre-Ex processing has been moved to a more detailed structure in PlanPrex tables. format: int32 nullable: true preEx_Range: type: integer description: 'Defines a range of days that is determined by comparing the start date of the plan and the disability date. If a disability claim falls within this defined range, the specified Ex Code will be applied to that claim.' format: int32 nullable: true preEx_Thru: type: integer description: No longer in use. Pre-Ex processing has been moved to a more detailed structure in PlanPrex tables. format: int32 nullable: true qpA_Method: maxLength: 1 type: string description: Determines the QPA Method to be used for claims under this Plan nullable: true reduced_Paid_Up_Default: type: integer description: Deault paid up value when Policy & Forfeiture is used in enrollment. format: int32 nullable: true remove_Member_Amount_Edit: type: boolean description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' situs_State: maxLength: 2 type: string description: State where the Plan originates or applies nullable: true sub_Ded_Credit: type: number description: Total deductible amount to be credited back to the Subscriber during adjudication. format: double nullable: true sub_Ded_Credit_OON: type: number description: Out of Network deductible amount to be credited back to the Subscriber during adjudication. format: double nullable: true sub_Ded_Credit_PPO: type: number description: In-Network deductible amount to be credited back to the Subscriber during adjudication. format: double nullable: true subscriber_Ded_OON: type: number description: Deductible amount for the Family Out of Network. format: double nullable: true subscriber_Ded_PPO: type: number description: Deductible amount for the Family In Network. format: double nullable: true subscriber_Deductible: type: number description: Total deductible amount for the Family both In Network and Out of Network. format: double nullable: true survivor_Benefit: type: integer description: Survivor Benefit associated with Disability plans. format: int32 nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true use_COB_Savings: type: boolean description: 'Indicates whether the COB should be used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false PlansListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Plans' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PlansVBAResponse: type: object properties: data: $ref: '#/components/schemas/Plans' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PolicyForfeitureExt: required: - policyForfeitureExt_Key type: object properties: policyForfeitureExt_Key: type: integer description: 'Key value identifying a policy forfeiture extension Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 description: maxLength: 512 type: string description: Description of a policy forfeiture extension nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false PolicyForfeitureExtDetail: required: - age_0_Day - age_0_Year - age_1_Day - age_1_Year - age_10_Day - age_10_Year - age_100_Day - age_100_Year - age_101_Day - age_101_Year - age_102_Day - age_102_Year - age_103_Day - age_103_Year - age_104_Day - age_104_Year - age_105_Day - age_105_Year - age_106_Day - age_106_Year - age_107_Day - age_107_Year - age_108_Day - age_108_Year - age_109_Day - age_109_Year - age_11_Day - age_11_Year - age_110_Day - age_110_Year - age_111_Day - age_111_Year - age_112_Day - age_112_Year - age_113_Day - age_113_Year - age_114_Day - age_114_Year - age_115_Day - age_115_Year - age_116_Day - age_116_Year - age_117_Day - age_117_Year - age_118_Day - age_118_Year - age_119_Day - age_119_Year - age_12_Day - age_12_Year - age_120_Day - age_120_Year - age_13_Day - age_13_Year - age_14_Day - age_14_Year - age_15_Day - age_15_Year - age_16_Day - age_16_Year - age_17_Day - age_17_Year - age_18_Day - age_18_Year - age_19_Day - age_19_Year - age_2_Day - age_2_Year - age_20_Day - age_20_Year - age_21_Day - age_21_Year - age_22_Day - age_22_Year - age_23_Day - age_23_Year - age_24_Day - age_24_Year - age_25_Day - age_25_Year - age_26_Day - age_26_Year - age_27_Day - age_27_Year - age_28_Day - age_28_Year - age_29_Day - age_29_Year - age_3_Day - age_3_Year - age_30_Day - age_30_Year - age_31_Day - age_31_Year - age_32_Day - age_32_Year - age_33_Day - age_33_Year - age_34_Day - age_34_Year - age_35_Day - age_35_Year - age_36_Day - age_36_Year - age_37_Day - age_37_Year - age_38_Day - age_38_Year - age_39_Day - age_39_Year - age_4_Day - age_4_Year - age_40_Day - age_40_Year - age_41_Day - age_41_Year - age_42_Day - age_42_Year - age_43_Day - age_43_Year - age_44_Day - age_44_Year - age_45_Day - age_45_Year - age_46_Day - age_46_Year - age_47_Day - age_47_Year - age_48_Day - age_48_Year - age_49_Day - age_49_Year - age_5_Day - age_5_Year - age_50_Day - age_50_Year - age_51_Day - age_51_Year - age_52_Day - age_52_Year - age_53_Day - age_53_Year - age_54_Day - age_54_Year - age_55_Day - age_55_Year - age_56_Day - age_56_Year - age_57_Day - age_57_Year - age_58_Day - age_58_Year - age_59_Day - age_59_Year - age_6_Day - age_6_Year - age_60_Day - age_60_Year - age_61_Day - age_61_Year - age_62_Day - age_62_Year - age_63_Day - age_63_Year - age_64_Day - age_64_Year - age_65_Day - age_65_Year - age_66_Day - age_66_Year - age_67_Day - age_67_Year - age_68_Day - age_68_Year - age_69_Day - age_69_Year - age_7_Day - age_7_Year - age_70_Day - age_70_Year - age_71_Day - age_71_Year - age_72_Day - age_72_Year - age_73_Day - age_73_Year - age_74_Day - age_74_Year - age_75_Day - age_75_Year - age_76_Day - age_76_Year - age_77_Day - age_77_Year - age_78_Day - age_78_Year - age_79_Day - age_79_Year - age_8_Day - age_8_Year - age_80_Day - age_80_Year - age_81_Day - age_81_Year - age_82_Day - age_82_Year - age_83_Day - age_83_Year - age_84_Day - age_84_Year - age_85_Day - age_85_Year - age_86_Day - age_86_Year - age_87_Day - age_87_Year - age_88_Day - age_88_Year - age_89_Day - age_89_Year - age_9_Day - age_9_Year - age_90_Day - age_90_Year - age_91_Day - age_91_Year - age_92_Day - age_92_Year - age_93_Day - age_93_Year - age_94_Day - age_94_Year - age_95_Day - age_95_Year - age_96_Day - age_96_Year - age_97_Day - age_97_Year - age_98_Day - age_98_Year - age_99_Day - age_99_Year - duration - policyForfeitureExt_Key - policyForfeitureExtDetail_Key type: object properties: policyForfeitureExtDetail_Key: type: integer description: Key value identifying a specific detail of a policy forfeiture extension format: int32 age_0_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_0_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_100_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_100_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_101_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_101_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_102_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_102_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_103_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_103_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_104_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_104_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_105_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_105_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_106_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_106_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_107_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_107_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_108_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_108_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_109_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_109_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_10_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_10_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_110_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_110_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_111_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_111_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_112_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_112_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_113_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_113_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_114_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_114_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_115_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_115_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_116_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_116_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_117_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_117_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_118_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_118_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_119_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_119_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_11_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_11_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_120_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_120_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_12_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_12_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_13_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_13_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_14_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_14_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_15_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_15_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_16_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_16_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_17_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_17_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_18_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_18_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_19_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_19_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_1_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_1_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_20_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_20_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_21_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_21_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_22_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_22_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_23_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_23_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_24_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_24_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_25_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_25_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_26_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_26_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_27_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_27_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_28_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_28_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_29_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_29_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_2_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_2_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_30_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_30_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_31_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_31_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_32_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_32_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_33_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_33_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_34_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_34_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_35_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_35_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_36_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_36_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_37_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_37_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_38_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_38_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_39_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_39_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_3_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_3_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_40_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_40_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_41_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_41_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_42_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_42_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_43_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_43_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_44_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_44_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_45_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_45_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_46_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_46_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_47_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_47_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_48_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_48_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_49_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_49_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_4_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_4_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_50_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_50_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_51_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_51_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_52_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_52_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_53_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_53_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_54_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_54_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_55_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_55_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_56_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_56_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_57_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_57_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_58_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_58_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_59_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_59_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_5_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_5_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_60_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_60_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_61_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_61_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_62_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_62_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_63_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_63_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_64_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_64_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_65_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_65_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_66_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_66_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_67_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_67_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_68_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_68_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_69_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_69_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_6_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_6_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_70_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_70_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_71_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_71_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_72_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_72_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_73_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_73_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_74_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_74_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_75_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_75_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_76_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_76_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_77_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_77_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_78_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_78_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_79_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_79_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_7_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_7_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_80_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_80_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_81_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_81_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_82_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_82_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_83_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_83_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_84_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_84_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_85_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_85_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_86_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_86_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_87_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_87_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_88_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_88_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_89_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_89_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_8_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_8_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_90_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_90_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_91_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_91_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_92_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_92_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_93_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_93_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_94_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_94_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_95_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_95_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_96_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_96_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_97_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_97_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_98_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_98_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_99_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_99_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 age_9_Day: type: integer description: Number of days added for the policy forfeiture extension based on the specified age format: int32 age_9_Year: type: integer description: Number of years added for the policy forfeiture extension based on the specified age format: int32 duration: type: integer description: Duration for the policy forfeiture extension format: int32 policyForfeitureExt_Key: type: integer description: Key value identifying a policy forfeiture extension format: int32 additionalProperties: false PolicyForfeitureExtDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PolicyForfeitureExtDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PolicyForfeitureExtDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/PolicyForfeitureExtDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PolicyForfeitureExtListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PolicyForfeitureExt' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PolicyForfeitureExtVBAResponse: type: object properties: data: $ref: '#/components/schemas/PolicyForfeitureExt' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PolicyStatus: required: - default_Status - policy_Status type: object properties: policy_Status: maxLength: 32 minLength: 1 type: string description: Identifier for a specific policy status default_Status: type: boolean description: 'Flag identifying if the policy status is the default status Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 256 type: string description: Description for a specific policy status nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false PolicyStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PolicyStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PolicyStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/PolicyStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PracticeType: required: - practice_Type type: object properties: practice_Type: maxLength: 16 minLength: 1 type: string description: Identifier for the specific type of practice description: maxLength: 512 type: string description: Description for the specific type of practice nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false PracticeTypeCriteria: type: object properties: practice_Type: type: string nullable: true additionalProperties: false PracticeTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PracticeType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PracticeTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PracticeType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremDistribution: required: - dist_Setting_Amount_Pct - premDistribution_Key type: object properties: premDistribution_Key: type: integer format: int32 account_Key: type: integer format: int32 nullable: true amount: type: number format: double nullable: true amount_Received: type: number format: double nullable: true benefit_Code: maxLength: 10 type: string nullable: true calculated_Distribution_Amount: type: number format: double nullable: true check_ID: type: integer format: int32 nullable: true dist_Setting_Amount: type: number format: double nullable: true dist_Setting_Amount_Max: type: number format: double nullable: true dist_Setting_Amount_Pct: type: boolean dist_Setting_Dist_Type: maxLength: 8 type: string nullable: true dist_Setting_Priority: type: integer format: int32 nullable: true dist_Setting_Rate: type: number format: double nullable: true dist_Setting_Rate_Max: type: number format: double nullable: true dist_Setting_Rate_Min: type: number format: double nullable: true dist_Setting_Rate_Round_Precision: type: integer format: int32 nullable: true dist_Setting_Rate_Round_Type: maxLength: 16 type: string nullable: true dist_Setting_Rate_Var1: type: number format: double nullable: true dist_Setting_Rate_Var2: type: number format: double nullable: true dist_Setting_Rate_Var3: type: number format: double nullable: true dist_Volume: type: number format: double nullable: true distribution_Amount: type: number format: double nullable: true division_ID: maxLength: 20 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true expense_Type: maxLength: 16 type: string nullable: true groupSelfAdmin_Key: type: integer format: int32 nullable: true group_ID: maxLength: 20 type: string nullable: true invoiceAdjustment_Key: type: integer format: int32 nullable: true invoice_Key: type: integer format: int32 nullable: true override_Distribution_Amount: type: number format: double nullable: true payee_ID: maxLength: 20 type: string nullable: true payor_ID: maxLength: 20 type: string nullable: true plan_ID: maxLength: 20 type: string nullable: true policy_Number: maxLength: 25 type: string nullable: true premRate_Key: type: integer format: int32 nullable: true previous_Distribution_Amount: type: number format: double nullable: true reference_ID: maxLength: 256 type: string nullable: true reinsurable_Volume: type: number format: double nullable: true subscriber_ID: maxLength: 9 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true void_PremDistribution_Key: type: integer format: int32 nullable: true volume: type: number format: double nullable: true additionalProperties: false PremDistributionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremDistribution' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremDistributionVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremDistribution' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoice: required: - finalized - invoice_Key type: object properties: invoice_Key: type: integer description: 'Unique identifier for the Invoice Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 additional_Invoice_Level: maxLength: 16 type: string description: Specifies invoice level of additional invoices defined on the prem rate. nullable: true bill_Address: maxLength: 128 type: string description: Address of the group or individual the Invoice is for nullable: true bill_Address2: maxLength: 128 type: string description: Second line for the Address of the group or individual the Invoice is for nullable: true bill_City: maxLength: 32 type: string description: City of the group or individual the Invoice is for nullable: true bill_County_Code: maxLength: 8 type: string description: County of the group or individual the Invoice is for. nullable: true bill_Name: maxLength: 256 type: string description: Name of the group or individual the Invoice is for nullable: true bill_State: maxLength: 2 type: string description: State of the group or individual the Invoice is for nullable: true bill_Zip_Code: maxLength: 32 type: string description: Zip Code of the group or individual the Invoice is for nullable: true billing_Cycle_ID: maxLength: 2 type: string description: This is the Billing Cycle the invoice was gerenated for. nullable: true billing_From: type: string description: First day of the Invoice period format: date-time nullable: true billing_Thru: type: string description: Last day of the Invoice period format: date-time nullable: true due_Date: type: string description: Due Date of the Invoice format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true finalized: type: boolean description: 'Finalized invoices cannot be changed Note: This field is marked as NOT NULL in the database and therefore required by the API.' finalized_Date: type: string description: Date the Invoice was Finalized format: date-time nullable: true finalized_User: maxLength: 20 type: string description: User that Finalized the Invoice nullable: true invoice_Date: type: string description: Date of the Invoice format: date-time nullable: true invoice_Level: maxLength: 1 type: string description: 'Level of the Invoice: Group, Division, or Subscriber' nullable: true invoice_Number: maxLength: 32 type: string description: Number assigned to this Invoice nullable: true invoice_Status: maxLength: 16 type: string description: 'Status of the Invoice: Open or Closed' nullable: true original_Invoice_Key: type: integer description: Identifies the Invoice that this Invoice was created from format: int32 nullable: true pay_Period: type: integer description: This number represents sequence of the payroll from the beginning of the payroll year. format: int32 nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false PremInvoiceAdjReceived: required: - premInvoiceAdjReceived_Key type: object properties: premInvoiceAdjReceived_Key: type: integer format: int32 adjustment_Received: type: number format: double nullable: true adjustment_Received_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true invoiceAdjustment_Key: type: integer format: int32 nullable: true premPayment_Key: type: integer format: int32 nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremInvoiceAdjReceivedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoiceAdjReceived' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceAdjReceivedVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremInvoiceAdjReceived' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceAdjustment: required: - auto_Adjust - avoid_Retro - invoiceAdjustment_Key - min_Max_Adjust - negative_Adjustment - selfAdmin_Adj - use_Premium type: object properties: invoiceAdjustment_Key: type: integer format: int32 adjustment_Amount: type: number format: double nullable: true adjustment_Comment: maxLength: 512 type: string nullable: true adjustment_PremRate_Key: type: integer format: int32 nullable: true adjustment_Reason: type: integer format: int32 nullable: true adjustment_Received: type: number format: double nullable: true auto_Adjust: type: boolean avoid_Retro: type: boolean division_ID: maxLength: 20 type: string nullable: true effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true group_ID: maxLength: 20 type: string nullable: true invoice_Key: type: integer format: int32 nullable: true min_Max_Adjust: type: boolean negative_Adjustment: type: boolean premRate_Key: type: integer format: int32 nullable: true retro_Adjustment_Invoice_Key: type: integer format: int32 nullable: true selfAdmin_Adj: type: boolean subscriber_ID: maxLength: 9 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true use_Premium: type: boolean volume: type: number format: double nullable: true additionalProperties: false PremInvoiceAdjustmentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoiceAdjustment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceAdjustmentVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremInvoiceAdjustment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceApplyPayment: required: - invoice_Key - payment_Posted - payment_Posted_Date - premPayment_Key - user_ID type: object properties: invoice_Key: type: integer format: int32 subscriber_ID: type: string description: "Required for:\r\n ApplyPaymentSubscriber\r\n ApplyPaymentSubscriberPayorID\r\n ApplyPaymentSubscriberPlanType\r\nNot used for:\r\n ApplyPaymentHeaderAdjustment" nullable: true plan_Type: type: string description: "Required for:\r\n ApplyPaymentSubscriberPlanType\r\nNot used for:\r\n ApplyPaymentSubscriber\r\n ApplyPaymentSubscriberPayorID\r\n ApplyPaymentHeaderAdjustment" nullable: true payor_ID: type: string description: "Required for:\r\n ApplyPaymentSubscriberPayorID\r\nNot used for:\r\n ApplyPaymentSubscriber\r\n ApplyPaymentSubscriberPlanType\r\n ApplyPaymentHeaderAdjustment" nullable: true premPayment_Key: type: integer format: int32 adjustment_Reason: type: integer description: "Required for:\r\n ApplyPaymentHeaderAdjustment\r\nNot used for:\r\n ApplyPaymentSubscriber\r\n ApplyPaymentSubscriberPayorID\r\n ApplyPaymentSubscriberPlanType" format: int32 nullable: true payment_Posted: type: number format: double payment_Posted_Date: type: string format: date-time user_ID: minLength: 1 type: string additionalProperties: false PremInvoiceGenerateInvList: type: object properties: selected: type: integer format: int32 invoice_Level_Sort: type: integer format: int32 invoice_Level_ID: type: string nullable: true invoice_Level: type: string nullable: true group_ID: type: string nullable: true groupName: type: string nullable: true division_ID: type: string nullable: true division_Name: type: string nullable: true bill_Cycle: type: string nullable: true last_Bill_Thru: type: string format: date-time nullable: true invoice_Date: type: string format: date-time nullable: true bill_From: type: string format: date-time nullable: true bill_Thru: type: string format: date-time nullable: true inv_Date_Bill_From: type: string format: date-time nullable: true inv_Date_Bill_Thru: type: string format: date-time nullable: true bill_Date_Option: type: integer format: int32 enrollmentCount: type: integer format: int32 nullable: true adjustmentCount: type: integer format: int32 nullable: true invoice_Key: type: integer format: int32 additionalProperties: false PremInvoiceGenerateInvListListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoiceGenerateInvList' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceGenerateInvListResult: type: object properties: selected: type: integer format: int32 invoice_Level_Sort: type: integer format: int32 invoice_Level_ID: type: string nullable: true invoice_Level: type: string nullable: true group_ID: type: string nullable: true groupName: type: string nullable: true division_ID: type: string nullable: true division_Name: type: string nullable: true bill_Cycle: type: string nullable: true last_Bill_Thru: type: string format: date-time nullable: true invoice_Date: type: string format: date-time nullable: true bill_From: type: string format: date-time nullable: true bill_Thru: type: string format: date-time nullable: true inv_Date_Bill_From: type: string format: date-time nullable: true inv_Date_Bill_Thru: type: string format: date-time nullable: true bill_Date_Option: type: integer format: int32 enrollmentCount: type: integer format: int32 nullable: true adjustmentCount: type: integer format: int32 nullable: true invoice_Key: type: integer format: int32 additionalProperties: false PremInvoiceGenerateInvListResultListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoiceGenerateInvListResult' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceGenerateSelfAdminInvList: type: object properties: selected: type: integer format: int32 invoice_Level_Sort: type: integer format: int32 invoice_Level_ID: type: string nullable: true invoice_Level: type: string nullable: true group_ID: type: string nullable: true group_Name: type: string nullable: true division_ID: type: string nullable: true division_Name: type: string nullable: true bill_Cycle: type: string nullable: true last_Bill_Thru: type: string format: date-time nullable: true invoice_Date: type: string format: date-time nullable: true bill_From: type: string format: date-time nullable: true bill_Thru: type: string format: date-time nullable: true inv_Date_Bill_From: type: string format: date-time nullable: true inv_Date_Bill_Thru: type: string format: date-time nullable: true bill_Date_Option: type: integer format: int32 subscribers: type: integer format: int32 nullable: true dependents: type: integer format: int32 nullable: true members: type: integer format: int32 nullable: true invoice_Key: type: integer format: int32 additionalProperties: false PremInvoiceGenerateSelfAdminInvListListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoiceGenerateSelfAdminInvList' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceGroupSummary: required: - adjustmentReceived - amountDue - dependentCount - detailAdjustment - headerAdjustment - memberCount - paidDependentCount - paidMemberCount - paidSubscriberCount - postedPayment - premium - premiumReceived - subscriberAdjustment - subscriberCount - unpostedAmount type: object properties: subscriberCount: type: integer format: int32 paidSubscriberCount: type: integer format: int32 dependentCount: type: integer format: int32 paidDependentCount: type: integer format: int32 memberCount: type: integer format: int32 paidMemberCount: type: integer format: int32 premium: type: number format: double premiumReceived: type: number format: double postedPayment: type: number format: double unpostedAmount: type: number format: double amountDue: type: number format: double headerAdjustment: type: number format: double subscriberAdjustment: type: number format: double adjustmentReceived: type: number format: double detailAdjustment: type: number format: double additionalProperties: false PremInvoiceGroupSummaryVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremInvoiceGroupSummary' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceIndividual: type: object properties: selected: type: integer format: int32 group_ID: type: string nullable: true division_ID: type: string nullable: true subscriber_ID: type: string nullable: true subscriberName: type: string nullable: true bill_Cycle: type: string nullable: true last_Bill_Thru: type: string format: date-time nullable: true invoice_Date: type: string format: date-time nullable: true bill_From: type: string format: date-time nullable: true bill_Thru: type: string format: date-time nullable: true inv_Date_Bill_From: type: string format: date-time nullable: true inv_Date_Bill_Thru: type: string format: date-time nullable: true bill_Date_Option: type: integer format: int32 additionalProperties: false PremInvoiceIndividualListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoiceIndividual' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoice' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoicePayment: required: - invoice_Key - premPayment_Key type: object properties: invoice_Key: type: integer format: int32 premPayment_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true payment_Posted: type: number format: double nullable: true payment_Posted_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremInvoicePaymentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoicePayment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoicePaymentVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremInvoicePayment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoicePayment_Ext: type: object properties: invoiceKey: type: integer description: Invoice the payment is for format: int32 premPaymentKey: type: integer description: Payment that is applied to the invoice format: int32 paymentId: type: string description: ID for the Payment nullable: true paymentAmount: type: number description: Amount of the Payment format: double paymentDate: type: string description: Date of the Payment format: date-time nullable: true invoicePostedPayments: type: number format: double paymentPosted: type: number description: Payment posted to the invoice format: double paymentPostedDate: type: string description: Date the Payment was Posted to the invoice format: date-time nullable: true paymentApplied: type: number description: 'Calculated field that sums the PremInvoiceReceived, PremInvoiceSelfAdminReceived and PremInvoiceAdjReceived.' format: double entryUser: type: string description: User that first added the record to the system nullable: true entryDate: type: string description: Date record was first added to the system format: date-time updateUser: type: string description: User that last updated the record in the system nullable: true updateDate: type: string description: Date the record was last updated in the system format: date-time additionalProperties: false description: Similar to the PremInvoicePayment class but has additional computed fields. PremInvoicePayment_ExtListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoicePayment_Ext' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceReceived: required: - division_ID - group_ID - invoice_Key - premInvoiceReceived_Key - premPayment_Key - premRate_Key - subscriber_ID type: object properties: premInvoiceReceived_Key: type: integer format: int32 division_ID: maxLength: 20 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true group_ID: maxLength: 20 minLength: 1 type: string invoice_Key: type: integer format: int32 premPayment_Key: type: integer format: int32 premRate_Key: type: integer format: int32 premium_Received: type: number format: double nullable: true premium_Received_Date: type: string format: date-time nullable: true subscriber_ID: maxLength: 20 minLength: 1 type: string update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremInvoiceReceivedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoiceReceived' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceReceivedVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremInvoiceReceived' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceSelfAdmin: required: - invoice_Key - premInvoiceSelfAdmin_Key type: object properties: premInvoiceSelfAdmin_Key: type: integer format: int32 age: type: integer format: int32 nullable: true benefit_Code: maxLength: 10 type: string nullable: true dependents: type: integer format: int32 nullable: true dist_Volume: type: number format: double nullable: true division_ID: maxLength: 20 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true groupSelfAdmin_Age: type: integer format: int32 nullable: true groupSelfAdmin_Dependents: type: integer format: int32 nullable: true groupSelfAdmin_Dist_Volume: type: number format: double nullable: true groupSelfAdmin_Key: type: integer format: int32 nullable: true groupSelfAdmin_Members: type: integer format: int32 nullable: true groupSelfAdmin_Premium: type: number format: double nullable: true groupSelfAdmin_Sex: maxLength: 1 type: string nullable: true groupSelfAdmin_Subscribers: type: integer format: int32 nullable: true groupSelfAdmin_Volume: type: number format: double nullable: true group_ID: maxLength: 20 type: string nullable: true invoice_Key: type: integer format: int32 members: type: integer format: int32 nullable: true plan_ID: maxLength: 20 type: string nullable: true premRate_Key: type: integer format: int32 nullable: true premium: type: number format: double nullable: true premium_Received: type: number format: double nullable: true sex: maxLength: 1 type: string nullable: true subscribers: type: integer format: int32 nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true volume: type: number format: double nullable: true additionalProperties: false PremInvoiceSelfAdminListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoiceSelfAdmin' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceSelfAdminReceived: required: - premInvoiceSelfAdmin_Key - premInvoiceSelfAdminReceived_Key type: object properties: premInvoiceSelfAdminReceived_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true premInvoiceSelfAdmin_Key: type: integer format: int32 premPayment_Key: type: integer format: int32 nullable: true premium_Received: type: number format: double nullable: true premium_Received_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremInvoiceSelfAdminReceivedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoiceSelfAdminReceived' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceSelfAdminReceivedVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremInvoiceSelfAdminReceived' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceSelfAdminVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremInvoiceSelfAdmin' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceSlim: type: object properties: invoice_Key: type: integer description: Unique identifier for the Invoice format: int32 invoice_Number: type: string description: Number assigned to this Invoice nullable: true invoice_Date: type: string description: Date of the Invoice format: date-time nullable: true additionalProperties: false PremInvoiceSlimListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoiceSlim' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceSubscriber: required: - division_ID - group_ID - invoice_Key - premium_Waived - subscriber_ID type: object properties: invoice_Key: type: integer format: int32 group_ID: maxLength: 20 minLength: 1 type: string division_ID: maxLength: 20 minLength: 1 type: string subscriber_ID: maxLength: 9 minLength: 1 type: string dependent_Count: type: integer format: int32 nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true member_Count: type: integer format: int32 nullable: true premium_Waived: type: boolean update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremInvoiceSubscriberDetail: required: - division_ID - group_ID - invoice_Key - premium_Waived - premRate_Key - subscriber_ID type: object properties: invoice_Key: type: integer format: int32 group_ID: maxLength: 20 minLength: 1 type: string division_ID: maxLength: 20 minLength: 1 type: string subscriber_ID: maxLength: 20 minLength: 1 type: string premRate_Key: type: integer format: int32 dist_Volume: type: number format: double nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true payee_ID: maxLength: 20 type: string nullable: true premium: type: number format: double nullable: true premium_Received: type: number format: double nullable: true premium_Waived: type: boolean update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true volume: type: number format: double nullable: true additionalProperties: false PremInvoiceSubscriberDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoiceSubscriberDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceSubscriberDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremInvoiceSubscriberDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceSubscriberListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremInvoiceSubscriber' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceSubscriberVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremInvoiceSubscriber' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremInvoiceVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremInvoice' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPastDueTrigger: required: - active - premPastDueTrigger_Key type: object properties: premPastDueTrigger_Key: type: integer format: int32 active: type: boolean entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true premPastDue_CreateDateRange: type: integer format: int32 nullable: true premPastDue_CreateDateRangeType: maxLength: 8 type: string nullable: true premPastDue_DateRange: type: integer format: int32 nullable: true premPastDue_DateRangeType: maxLength: 8 type: string nullable: true premPastDue_DateType: maxLength: 32 type: string nullable: true premPastDue_Description: maxLength: 512 type: string nullable: true premPastDue_ID: maxLength: 32 type: string nullable: true reportSeries_Key: type: integer format: int32 nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremPastDueTriggerGroup: required: - group_ID - premPastDueTriggerGroup_Key type: object properties: premPastDueTriggerGroup_Key: type: integer format: int32 division_ID: maxLength: 20 type: string nullable: true effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true group_ID: maxLength: 20 minLength: 1 type: string premPastDueTrigger_Key: type: integer format: int32 nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremPastDueTriggerGroupListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremPastDueTriggerGroup' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPastDueTriggerGroupVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremPastDueTriggerGroup' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPastDueTriggerListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremPastDueTrigger' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPastDueTriggerSubscriber: required: - premPastDueTriggerSubscriber_Key - subscriber_ID type: object properties: premPastDueTriggerSubscriber_Key: type: integer format: int32 effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true premPastDueTrigger_Key: type: integer format: int32 nullable: true subscriber_ID: maxLength: 9 minLength: 1 type: string term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremPastDueTriggerSubscriberListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremPastDueTriggerSubscriber' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPastDueTriggerSubscriberVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremPastDueTriggerSubscriber' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPastDueTriggerVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremPastDueTrigger' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPayment: required: - premPayment_Key type: object properties: premPayment_Key: type: integer format: int32 account_Key: type: integer format: int32 nullable: true division_ID: maxLength: 20 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true funding_Key: type: integer format: int32 nullable: true group_ID: maxLength: 20 type: string nullable: true payment_Amount: type: number format: double nullable: true payment_Date: type: string format: date-time nullable: true payment_ID: maxLength: 64 type: string nullable: true payment_Name: maxLength: 256 type: string nullable: true payment_Type: maxLength: 32 type: string nullable: true payor_ID: maxLength: 20 type: string nullable: true subscriber_ID: maxLength: 9 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremPaymentFileFormat: required: - payment_File_Format_Key type: object properties: payment_File_Format_Key: type: integer description: 'Unique identifier of the PremPaymentFileFormat table Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 business_Object: maxLength: 64 type: string description: PowerBuilder object that defines the file layout nullable: true description: maxLength: 512 type: string description: Description of the File Format nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true format: maxLength: 32 type: string description: Not used nullable: true length: type: integer description: Not used format: int32 nullable: true payment_Type: maxLength: 16 type: string description: Type of the Payment nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false PremPaymentFileFormatListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremPaymentFileFormat' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPaymentFileFormatVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremPaymentFileFormat' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPaymentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremPayment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPaymentOnAccount: required: - premPayment_Key - premPaymentOnAccount_Key type: object properties: premPaymentOnAccount_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true group_ID: maxLength: 20 type: string nullable: true payment_Amount: type: number format: double nullable: true payment_Posted: type: number format: double nullable: true payor_ID: maxLength: 20 type: string nullable: true plan_Type: maxLength: 6 type: string nullable: true premPayment_Key: type: integer format: int32 subscriber_ID: maxLength: 9 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremPaymentOnAccountListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremPaymentOnAccount' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPaymentOnAccountVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremPaymentOnAccount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPaymentSubscriber: required: - premPayment_Key - subscriber_ID type: object properties: premPayment_Key: type: integer format: int32 subscriber_ID: maxLength: 9 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true payment_Amount: type: number format: double nullable: true payment_Posted: type: number format: double nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremPaymentSubscriberListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremPaymentSubscriber' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPaymentSubscriberVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremPaymentSubscriber' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPaymentType: required: - payment_Type type: object properties: payment_Type: maxLength: 32 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremPaymentTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremPaymentType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPaymentTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremPaymentType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremPaymentVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremPayment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRate: required: - adult - assign_To_New_Division - assign_To_New_Group - assign_To_New_Member - auto_Adjust - avoid_Retro - child - employer_Contribution_Pct - group_Division_Offering - new_Hire_Age - override_Enrolled_Dates - premium_Proration - premRate_Key type: object properties: premRate_Key: type: integer description: 'Unique identifier for the PremRate Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 add_On_Grouping_ID: maxLength: 32 type: string description: Used to identify Add On rates by Group nullable: true additional_Invoice_Address: maxLength: 4 type: string description: Address the additional invoice is sent to nullable: true additional_Invoice_Frequency: maxLength: 2 type: string description: Frequency of the additional invoice nullable: true additional_Invoice_Level: maxLength: 16 type: string description: Allows split billing at this level nullable: true address_Type: maxLength: 16 type: string description: Level of the Address used to determine if the rate applies nullable: true adjustment_Reason: type: integer description: Adjustment Reason of the PremRate format: int32 nullable: true adult: type: boolean description: 'Flag used to determine if the rate applies to Adults Note: This field is marked as NOT NULL in the database and therefore required by the API.' age_From: type: integer description: Beginning Age range of the PremRate format: int32 nullable: true age_Thru: type: integer description: Ending Age range of the PremRate format: int32 nullable: true age_Type: maxLength: 16 type: string description: Detemines what date is used to calculate Age nullable: true age_Type_Month: maxLength: 2 type: string description: Detemines what Month is used if the Month Type is selected nullable: true assign_To_New_Division: type: boolean description: 'Flag to determine if the rate applies to new Divisions Note: This field is marked as NOT NULL in the database and therefore required by the API.' assign_To_New_Group: type: boolean description: 'Flag to determine if the rate applies to new Groups Note: This field is marked as NOT NULL in the database and therefore required by the API.' assign_To_New_Member: type: boolean description: 'Flag to determine if the rate applies to new Members Note: This field is marked as NOT NULL in the database and therefore required by the API.' auto_Adjust: type: boolean description: 'Flag that determines if the rate is automatically adjusted Note: This field is marked as NOT NULL in the database and therefore required by the API.' auto_Adjust_Reason: type: integer description: Reason applied to automatic adjustments format: int32 nullable: true avoid_Retro: type: boolean description: 'This flag indicates prevention of the retro logic from creating backout adjustments for this rate Note: This field is marked as NOT NULL in the database and therefore required by the API.' benefit_Code: maxLength: 10 type: string description: Benefit Code of the PremRate nullable: true billing_Cycle_ID: maxLength: 2 type: string description: This is the Billing Cycle the invoice was gerenated for. nullable: true child: type: boolean description: 'Flag used to determine if the rate applies to Children Note: This field is marked as NOT NULL in the database and therefore required by the API.' city: maxLength: 32 type: string description: City of the Address used to determine if the rate applies nullable: true class_Code: maxLength: 32 type: string description: Class Code for the PremRate nullable: true country_ID: maxLength: 8 type: string description: Country ID of the Address used to determine if the rate applies nullable: true county_Code: maxLength: 8 type: string description: Country Code of the Address used to determine if the rate applies nullable: true description: maxLength: 128 type: string description: Description of the PremRate nullable: true division_ID: maxLength: 20 type: string description: Unique identifier for the Division nullable: true effective_Date: type: string description: Effective Date of the PremRate format: date-time nullable: true effective_Date_Type: maxLength: 16 type: string description: 'Determines the logic that modifies the Effective Date of the PremRate to a date based on the enrollment of the member. Note: The database will apply a default value of `NORMAL` for this field if a value is not provided.' nullable: true employee_Employer_Contribution: maxLength: 2 type: string description: Determines if the contribution is Employee or Employer nullable: true employer_Contribution: type: number description: Amount of the contribution format: double nullable: true employer_Contribution_Pct: type: boolean description: 'Determines if the contribution is a percentage Note: This field is marked as NOT NULL in the database and therefore required by the API.' employer_Rate: type: number description: Decimal value that defines the base employer rate format: double nullable: true employer_Rate_Max: type: number description: Maximum the employer rate will be regardless of the calculation format: double nullable: true employer_Rate_Minimum: type: number description: Minimum the employer rate will be regardless of the calculation format: double nullable: true employer_Rate_Type: maxLength: 32 type: string description: Type of Employer Rate nullable: true employer_Rate_Variable1: type: number description: First variable used in calculating the employer rate based on the type format: double nullable: true employer_Rate_Variable2: type: number description: Second variable used in calculating the employer rate based on the type format: double nullable: true employer_Rate_Variable3: type: number description: Third variable used in calculating the employer rate based on the type format: double nullable: true employer_Round_Precision: type: integer description: Precision that the employerrate is rounded to format: int32 nullable: true employer_Round_Type: maxLength: 16 type: string description: Type that determine how the employer rate is rounded nullable: true enrolled_Count_From: type: integer description: Beginning range based on number of enrollments format: int32 nullable: true enrolled_Count_Thru: type: integer description: Ending range based on number of enrollments format: int32 nullable: true enrolled_Count_Type: maxLength: 16 type: string description: Type of enrollments used to calculate the number of enrollments nullable: true enrolled_Duration_From: type: integer description: Beginning range based on length of enrollment format: int32 nullable: true enrolled_Duration_Min: type: integer description: Minimum length of enrollment format: int32 nullable: true enrolled_Duration_Option: maxLength: 16 type: string description: Determines if the date is based on the Member or the Plan enrollment nullable: true enrolled_Duration_Thru: type: integer description: Ending range based on length of enrollment format: int32 nullable: true enrolled_Duration_Type: maxLength: 16 type: string description: Type of date used to determine the enrollment range nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true group_Division_Offering: type: boolean description: 'Used to determine which records are updated when applying changes to a template Note: This field is marked as NOT NULL in the database and therefore required by the API.' group_ID: maxLength: 20 type: string description: Unique identifier for the Group nullable: true member_Seq: maxLength: 2 type: string description: Unique sequence for a Member nullable: true network_ID: maxLength: 10 type: string description: Unique identifier for the Network nullable: true network_Type: maxLength: 16 type: string description: Type of Network nullable: true new_Hire_Age: type: boolean description: 'Flag that determines the Age based on the date of hire Note: This field is marked as NOT NULL in the database and therefore required by the API.' override_Enrolled_Dates: type: boolean description: 'This flag indicates the rate should be paid if enrolled in for even a single day during the month. Note: This field is marked as NOT NULL in the database and therefore required by the API.' parent_PremRate_Key: type: integer description: PremRate_Key of the template rate this rate was created from format: int32 nullable: true payment_Method: maxLength: 20 type: string description: The primary key of the payment method nullable: true plan_ID: maxLength: 20 type: string description: Unique identifier for the Plan nullable: true plan_Type: maxLength: 6 type: string description: Type of Plan nullable: true premRate_Basis: maxLength: 32 type: string description: Basis of the PremRate nullable: true premRate_Category: maxLength: 32 type: string description: Category of the PremRate nullable: true premRate_ID: maxLength: 32 type: string description: Unique identifier for the PremRate nullable: true premRate_Type: maxLength: 16 type: string description: Type of the PremRate nullable: true premium_Proration: type: boolean description: 'Flag that determines if the rate is prorated Note: This field is marked as NOT NULL in the database and therefore required by the API.' rate: type: number description: Decimal value that defines the base rate format: double nullable: true rate_Max: type: number description: Maximum the rate will be regardless of the calculation format: double nullable: true rate_Minimum: type: number description: Minimum the rate will be regardless of the calculation format: double nullable: true rate_Pace: maxLength: 16 type: string description: How often the rate applies nullable: true rate_Pace_Type: maxLength: 16 type: string description: The day the rate applies when the pace is weekly nullable: true rate_Round_Precision: type: integer description: Precision that the rate is rounded to format: int32 nullable: true rate_Round_Type: maxLength: 16 type: string description: Type that determine how the rate is rounded nullable: true rate_Type: maxLength: 32 type: string description: Type of Rate nullable: true rate_Variable1: type: number description: First variable used in calculating the rate based on the type format: double nullable: true rate_Variable2: type: number description: Second variable used in calculating the rate based on the type format: double nullable: true rate_Variable3: type: number description: Third variable used in calculating the rate based on the type format: double nullable: true region_Code: maxLength: 32 type: string description: Region Code of the Address used to determine if the rate applies nullable: true relationship: maxLength: 12 type: string description: Relationship for the PremRate nullable: true sex: maxLength: 1 type: string description: Flag used to determine what Sex the rate applies to nullable: true smoker: maxLength: 1 type: string description: Flag to determine if the rate applies to Smokers nullable: true state: maxLength: 2 type: string description: State of the Address used to determine if the rate applies nullable: true subscriber_ID: maxLength: 9 type: string description: Unique identifier for the Subscriber nullable: true term_Date: type: string description: Term Date of the PremRate format: date-time nullable: true term_Date_type: maxLength: 16 type: string description: 'Determines the logic that modifies the Term Date of the PremRate to a date based on the enrollment of the member. Note: The database will apply a default value of `NORMAL` for this field if a value is not provided.' nullable: true tier: maxLength: 2 type: string description: Tier of the PremRate nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true zip_Code_From: maxLength: 32 type: string description: Beginning Zip Code of the Address used to determine if the rate applies nullable: true zip_Code_Thru: maxLength: 32 type: string description: Ending Zip Code of the Address used to determine if the rate applies nullable: true additionalProperties: false PremRateAddOn: required: - addOn_PremRate_Key - premRate_Key - premRateAddOn_Key type: object properties: premRateAddOn_Key: type: integer description: 'Unique ID of the Add On Rate associated with a given Premium Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 addOn_PremRate_Key: type: integer description: 'Unique ID of the Add On Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 add_On_Grouping_ID: maxLength: 32 type: string description: Used to identify Add On rates by Group nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true premRate_Key: type: integer description: 'Unique ID for the Premium Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 sequence: type: integer description: The suquence of this Category on the "INV" report. format: int32 nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false PremRateAddOnListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRateAddOn' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateAddOnVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRateAddOn' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateAgeType: required: - age_Type type: object properties: age_Type: maxLength: 16 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremRateAgeTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRateAgeType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateAgeTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRateAgeType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateBasis: required: - premRate_Basis type: object properties: premRate_Basis: maxLength: 32 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true rate_Display: maxLength: 256 type: string nullable: true rate_Display_Required_Fields: maxLength: 256 type: string nullable: true rate_Display_Sort: maxLength: 256 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremRateBasisListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRateBasis' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateBasisVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRateBasis' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateCategory: required: - premRate_Category type: object properties: premRate_Category: maxLength: 32 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremRateCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRateCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRateCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateExclude: required: - premRate_Key - premRateExclude_Key type: object properties: premRateExclude_Key: type: integer format: int32 benefit_Code: maxLength: 10 type: string nullable: true division_ID: maxLength: 20 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true network_ID: maxLength: 10 type: string nullable: true network_Type: maxLength: 16 type: string nullable: true plan_ID: maxLength: 20 type: string nullable: true plan_Type: maxLength: 6 type: string nullable: true premRate_Key: type: integer format: int32 tier: maxLength: 2 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremRateExcludeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRateExclude' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateExcludeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRateExclude' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateMember: required: - effective_Date - member_Seq - premRate_Key - subscriber_ID type: object properties: premRate_Key: type: integer format: int32 subscriber_ID: maxLength: 9 minLength: 1 type: string member_Seq: maxLength: 2 minLength: 1 type: string effective_Date: type: string format: date-time entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true rate_Override: type: number format: double nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremRateMemberListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRateMember' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateMemberVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRateMember' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateMinMax: required: - premRateMinMax_Key type: object properties: premRateMinMax_Key: type: integer format: int32 adjustment_Reason: type: integer format: int32 nullable: true description: maxLength: 512 type: string nullable: true division_ID: maxLength: 20 type: string nullable: true effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true group_ID: maxLength: 20 type: string nullable: true min_Max: maxLength: 1 type: string nullable: true min_Max_Value: type: number format: double nullable: true subscriber_ID: maxLength: 9 type: string nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremRateMinMaxDetail: required: - distribution_Rate - premRate_Key - premRateMinMax_Key type: object properties: premRateMinMax_Key: type: integer format: int32 premRate_Key: type: integer format: int32 distribution_Rate: type: boolean entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremRateMinMaxDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRateMinMaxDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateMinMaxDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRateMinMaxDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateMinMaxListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRateMinMax' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateMinMaxVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRateMinMax' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateNested: type: object properties: group_ID: type: string nullable: true group_Name: type: string nullable: true divisionConfigs: type: array items: $ref: '#/components/schemas/PremRate_DivisionConfig' nullable: true additionalProperties: false PremRateNestedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRateNested' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRatePace: required: - rate_Pace type: object properties: rate_Pace: maxLength: 16 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremRatePaceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRatePace' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRatePaceType: required: - rate_Pace_Type type: object properties: rate_Pace_Type: maxLength: 16 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true rate_Pace: maxLength: 16 type: string nullable: true sort_Order: type: integer format: int32 nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremRatePaceTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRatePaceType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRatePaceTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRatePaceType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRatePaceVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRatePace' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRatePayee: required: - amount_Pct - payee_ID - premRate_Key type: object properties: premRate_Key: type: integer format: int32 payee_ID: maxLength: 20 minLength: 1 type: string account_Key: type: integer format: int32 nullable: true amount: type: number format: double nullable: true amount_Max: type: number format: double nullable: true amount_Pct: type: boolean dist_Type: maxLength: 8 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true payor_ID: maxLength: 20 type: string nullable: true policy_Number: maxLength: 25 type: string nullable: true premRate_Category: maxLength: 32 type: string nullable: true priority: type: integer format: int32 nullable: true rate: type: number format: double nullable: true rate_Max: type: number format: double nullable: true rate_Min: type: number format: double nullable: true rate_Round_Precision: type: integer format: int32 nullable: true rate_Round_Type: maxLength: 16 type: string nullable: true rate_Var1: type: number format: double nullable: true rate_Var2: type: number format: double nullable: true rate_Var3: type: number format: double nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false PremRatePayeeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRatePayee' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRatePayeeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRatePayee' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateType: required: - addOn_Type - adjustment_Type - premium_Type - rate_Type type: object properties: rate_Type: maxLength: 32 minLength: 1 type: string description: Unique identifier of the Rate Type addOn_Type: type: boolean description: 'Identifies the type of Add On rate to be applied Note: This field is marked as NOT NULL in the database and therefore required by the API.' adjustment_Type: type: boolean description: 'Flag that determines if the Rate Type includes Adjustments Note: This field is marked as NOT NULL in the database and therefore required by the API.' description: maxLength: 128 type: string description: Description of the Rate Type nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true premium_Type: type: boolean description: 'Flag that determines if the Rate Type includes Premiums Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false PremRateTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRateType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRateType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateZip: required: - premRate_Key - premRateZip_Key - zip_From - zip_Thru type: object properties: premRateZip_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true premRate_Key: type: integer format: int32 update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true zip_From: maxLength: 16 minLength: 1 type: string zip_Thru: maxLength: 16 minLength: 1 type: string additionalProperties: false PremRateZipListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PremRateZip' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRateZipVBAResponse: type: object properties: data: $ref: '#/components/schemas/PremRateZip' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false PremRate_BasisConfig: type: object properties: premRate_Basis: type: string nullable: true premRate_Basis_Description: type: string nullable: true rates: type: array items: $ref: '#/components/schemas/PremRate_Rate' nullable: true additionalProperties: false PremRate_CategoryConfig: type: object properties: premRate_Category: type: string nullable: true premRate_Category_Description: type: string nullable: true basisConfigs: type: array items: $ref: '#/components/schemas/PremRate_BasisConfig' nullable: true additionalProperties: false PremRate_DivisionConfig: type: object properties: division_ID: type: string nullable: true division_Name: type: string nullable: true planConfigs: type: array items: $ref: '#/components/schemas/PremRate_PlanConfig' nullable: true additionalProperties: false PremRate_PlanConfig: type: object properties: plan_ID: type: string nullable: true plan_Description: type: string nullable: true categoryConfigs: type: array items: $ref: '#/components/schemas/PremRate_CategoryConfig' nullable: true additionalProperties: false PremRate_Rate: type: object properties: premRate_Key: type: integer format: int32 rate_Description: type: string nullable: true additionalProperties: false ProcedureCategory: required: - category_ID type: object properties: category_ID: maxLength: 32 minLength: 1 type: string description: Name of the 'Procedure Category'. description: maxLength: 128 type: string description: Description of the 'Procedure Category'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ProcedureCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProcedureCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcedureCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProcedureCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcedureCluster: required: - procedure_Cluster type: object properties: procedure_Cluster: maxLength: 32 minLength: 1 type: string description: maxLength: 256 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ProcedureClusterDetail: required: - procedure_Cluster - procedure_Code1 - procedure_Code2 - procedureClusterDetail_Key type: object properties: procedureClusterDetail_Key: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true procedure_Cluster: maxLength: 32 minLength: 1 type: string procedure_Code1: type: boolean procedure_Code2: type: boolean procedure_Code_From: maxLength: 8 type: string nullable: true procedure_Code_Thru: maxLength: 8 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ProcedureClusterDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProcedureClusterDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcedureClusterDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProcedureClusterDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcedureClusterListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProcedureCluster' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcedureClusterVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProcedureCluster' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcedureCode: required: - age_Restricted - procedure_Code - require_Auth type: object properties: procedure_Code: maxLength: 8 minLength: 1 type: string description: Code assigned to the associated procedure. age_Range_Type: maxLength: 1 type: string description: Indicates how age is defined within the age range. 'End of month' means that the age will be updated when the birth ends. 'Birth Date' means that the age will be updated on the date of birth. nullable: true age_Restricted: type: boolean description: 'Indicates that the associated procedure is limited to a certain age range. Note: This field is marked as NOT NULL in the database and therefore required by the API.' age_Type: maxLength: 16 type: string description: Identifies how the age range is defined. nullable: true category_ID: maxLength: 32 type: string description: Indicates the procedure category that the associated procedure belongs to. nullable: true description: maxLength: 128 type: string description: Text field where the User may enter a short description of the associated procedure. nullable: true effective_Date: type: string description: Date when the associated procedure code becomes/became effective. format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true from_Age: type: integer description: Identifies the starting age for the acceptable age range for the associated procedure code. format: int32 nullable: true gender: maxLength: 1 type: string description: Indicates a required gender for the associated procedure code. nullable: true long_Description: maxLength: 512 type: string description: Text field where the User may enter a longer and more detailed description of the associated procedure. nullable: true network_Price: type: number description: Network Price associated with the procedure code format: double nullable: true pend_Ex_Code: maxLength: 6 type: string description: Indicates the Ex Code that will be applied to claims that contain the associated procedure. nullable: true pend_Flag: maxLength: 1 type: string description: Allows the User to choose an Ex Code that will be applied to claims that contain the associated procedure. nullable: true procedure_Group: type: integer description: Identifies the group of procedures that the associated procedure belongs to. format: int32 nullable: true qualifier: maxLength: 2 type: string description: Identifies a procedure code as a revenue code. nullable: true require_Auth: type: boolean description: 'Indicates that an auth will be required when the associated procedure is used within a claim. Note: This field is marked as NOT NULL in the database and therefore required by the API.' term_Date: type: string description: Date when the associated procedure code expires/expired. format: date-time nullable: true thru_Age: type: integer description: Identifies the ending age for the acceptable age range for the associated procedure code. format: int32 nullable: true treatment_Type: maxLength: 8 type: string description: Identifier specifying the treatment type associated with the procedure code nullable: true ucR_Price: type: number description: Usual and Customary Price associated with the procedure code format: double nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ProcedureCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProcedureCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcedureCodeQualifier: required: - qualifier type: object properties: qualifier: maxLength: 2 minLength: 1 type: string description: maxLength: 64 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ProcedureCodeQualifierListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProcedureCodeQualifier' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcedureCodeQualifierVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProcedureCodeQualifier' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcedureCodeSet: required: - code_Set - procedure_Code type: object properties: procedure_Code: maxLength: 8 minLength: 1 type: string code_Set: maxLength: 6 minLength: 1 type: string description: maxLength: 64 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ProcedureCodeSetListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProcedureCodeSet' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcedureCodeSetVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProcedureCodeSet' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcedureCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProcedureCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcedureGroup: required: - procedure_Group type: object properties: procedure_Group: type: integer description: 'Name for the ''Procedure Group''. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 50 type: string description: Description of the 'Procedure Group'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ProcedureGroupListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProcedureGroup' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcedureGroupVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProcedureGroup' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProcessCheckOption: type: object properties: payor_ID: type: string nullable: true account_Key: type: integer format: int32 nullable: true signature_Key: type: integer format: int32 nullable: true additionalProperties: false ProfileProvider_AddressProvider: type: object properties: profileProvider: $ref: '#/components/schemas/Provider' addressProviders: type: array items: $ref: '#/components/schemas/Provider' nullable: true additionalProperties: false ProfileProvider_AddressProviderVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProfileProvider_AddressProvider' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Provider: required: - accepting_Patients - accepts_Capitation - accepts_Plan_Fees - accepts_Withhold - active - advice_To_Pay - fax_Opt_Out - handicap_Access - nitrous_Oxide - plan_Provider - print_Auth - sole_Proprietor - use_Procedure_Code type: object properties: provider_ID: maxLength: 20 type: string description: Unique idenfitier assigned to the Proivider record. nullable: true accepting_Age_From: type: integer description: Beginning of the range of accepted patient ages. format: int32 nullable: true accepting_Age_Thru: type: integer description: End of the range of accepted patient ages. format: int32 nullable: true accepting_Patients: type: boolean description: 'Indicates whether the selected Provider is accepting new patients. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' accepts_Capitation: type: boolean description: 'No longer in use. This fields has been replaced by the Credentialing tables. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' accepts_Plan_Fees: type: boolean description: No longer in use. This fields has been replaced by the Credentialing tables. accepts_Withhold: type: boolean description: 'No longer in use. This fields has been replaced by the Credentialing tables. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' active: type: boolean description: 'Indicates whether the Provider is active. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' address: maxLength: 90 type: string description: Street address of the rendering location. nullable: true address2: maxLength: 128 type: string description: Address line 2 for the Provider entity. nullable: true advice_To_Pay: type: boolean description: 'When this option is selected, adjudication to mark every claim as ''Advice to Pay'' (ATP). Advice to Pay claims do not produce check records when processed. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' after_Hours_Procedures: type: string description: No longer in use. This fields has been replaced by the Credentialing tables. nullable: true alternate_ID: maxLength: 20 type: string description: Alternate identifier for the selected Provider. nullable: true blid: maxLength: 64 type: string description: BaseLoad Key for this Service Provider location. nullable: true birth_Date: type: string description: Provider's date of birth. (Not required if Entity is non-Person) format: date-time nullable: true birth_Place: maxLength: 50 type: string description: Provider's place of birth. (If the entity is a Person) nullable: true board_Certification: type: string description: No longer in use. This fields has been replaced by the Credentialing tables. nullable: true city: maxLength: 30 type: string description: City of the rendering location. nullable: true communication_Method: maxLength: 16 type: string description: Indicates the Provider's preferred method of communication. nullable: true country_ID: maxLength: 8 type: string description: Country code associated with the Provider entity. nullable: true county_Code: maxLength: 8 type: string description: County code associated with the Provider entity. nullable: true deA_Number: maxLength: 20 type: string description: No longer in use. This fields has been replaced by the Credentialing tables. nullable: true discount_Percent: type: number description: This option adjusts the 'Allowed Amount' above (positive values) or below (negative values) the 'Billed Amount' by the entered percentage. format: double nullable: true education: type: string description: Educational background of the Provider. (If the entity is a Person) nullable: true effective_Date: type: string description: Indicates the effectiveness of this provider at this service location. Independent of Network effectiveness. format: date-time nullable: true email_Address: maxLength: 128 type: string description: Email address of the Provider entity. nullable: true emergency_Country_Code: maxLength: 8 type: string description: Country code of the emergency phone number associated with the Provider entity. nullable: true emergency_Phone: maxLength: 20 type: string description: Emergency phone number of the Provider. nullable: true entity_ID: maxLength: 1 type: string description: Unique identifier assigned to the Provider entity. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ethnicity_Code: maxLength: 1 type: string description: Identifies the type of individual Provider or Provider entity. nullable: true expiration_Date: type: string description: Indicates the effectiveness of this provider at this service location. Independent of Network effectiveness. format: date-time nullable: true fax_Country_Code: maxLength: 8 type: string description: Country code of the fax number associated with the Provider entity. nullable: true fax_Number: maxLength: 20 type: string description: Fax number associated with the Provider's rendering location. nullable: true fax_Opt_Out: type: boolean description: 'Indicates that the Provider is opted out of fax communication. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' federal_ID: maxLength: 20 type: string description: Provider's federal tax identification number. nullable: true first_Name: maxLength: 30 type: string description: First name of the Provider. (Not required if Entity is non-Person) nullable: true handicap_Access: type: boolean description: 'Indicates whether the Provider facilities have handicap accessibility. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' home_Address: maxLength: 90 type: string description: Home address of the Provider. (If the entity is a Person) nullable: true home_City: maxLength: 30 type: string description: City of the home address of the Provider. (If the entity is a Person) nullable: true home_Country_Code: maxLength: 8 type: string description: Country code of the home phone number associated with the Provider entity. nullable: true home_Country_ID: maxLength: 8 type: string description: Country indicator for Provider home address. nullable: true home_Phone: maxLength: 20 type: string description: Home phone number of the Provider. nullable: true home_State: maxLength: 10 type: string description: State of the home address of the Provider. (If the entity is a Person) nullable: true home_Zip_Code: maxLength: 32 type: string description: Zip Code of the Provider's home address. nullable: true hours: type: string description: Hours of operation for the Provider. nullable: true ivR_Code: maxLength: 10 type: string description: This field is sometimes used to track an IVR Code for the providers IVR system. nullable: true initial_Cred_Date: type: string description: No longer in use. This fields has been replaced by the Credentialing tables. format: date-time nullable: true ins_Agent: maxLength: 50 type: string description: No longer in use. This fields has been replaced by the Credentialing tables. nullable: true ins_Carrier: maxLength: 50 type: string description: No longer in use. This fields has been replaced by the Credentialing tables. nullable: true ins_Coverage_Amt: maxLength: 50 type: string description: No longer in use. This fields has been replaced by the Credentialing tables. nullable: true ins_Expiration_Date: type: string description: No longer in use. This fields has been replaced by the Credentialing tables. format: date-time nullable: true ins_Policy_Number: maxLength: 25 type: string description: No longer in use. This fields has been replaced by the Credentialing tables. nullable: true languages: type: string description: Lists the languages that able to be spoken/translated at the facility. nullable: true last_Name: maxLength: 30 type: string description: Last name of the Provider. (Not required if Entity is non-Person) nullable: true latitude: type: number description: Latitudinal coordinate of the Provider entity's location. format: double nullable: true license_Number: maxLength: 20 type: string description: No longer in use. This fields has been replaced by the Credentialing tables. nullable: true longitude: type: number description: Longitudinal coordinate of the Provider entity's location. format: double nullable: true malp_Aggregate_Limit: type: integer description: No longer in use. This fields has been replaced by the Credentialing tables. format: int32 nullable: true malp_Carrier_ID: maxLength: 20 type: string description: No longer in use. This fields has been replaced by the Credentialing tables. nullable: true malp_Exp_Date: type: string description: No longer in use. This fields has been replaced by the Credentialing tables. format: date-time nullable: true malp_Policys: maxLength: 200 type: string description: No longer in use. This fields has been replaced by the Credentialing tables. nullable: true malp_Specific_Limit: type: integer description: No longer in use. This fields has been replaced by the Credentialing tables. format: int32 nullable: true medicaid_ID: maxLength: 20 type: string description: Unique Medicaid identifier associated with the Provider. nullable: true medicare_Cert_ID: maxLength: 20 type: string description: No longer in use. This fields has been replaced by the Credentialing tables. nullable: true middle_Name: maxLength: 20 type: string description: Middle initial of the Provider. nullable: true nitrous_Oxide: type: boolean description: 'Indicates whether the Provider facilities have nitrous oxide available for patients. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' no_Pends_On_Remit: maxLength: 1 type: string description: 'When this option is selected, the Provider remit will not include pends. This only works if a custom report is designed to use this option.' nullable: true notes: type: string description: 'No longer in use. Replaced by the NoteData, NoteSource and NoteReference tables.' nullable: true oshA_Procedures: type: string description: No longer in use. This fields has been replaced by the Credentialing tables. nullable: true office_Manager: maxLength: 50 type: string description: Name of the Provider's Office Manager. nullable: true org_Name: maxLength: 512 type: string description: Organization that the Provider belongs to. nullable: true other_Name: maxLength: 96 type: string description: Any other names that the Provider uses. nullable: true pend_Ex_Code: maxLength: 6 type: string description: Specifies the Ex Code that should be applied when the 'Apply Ex Code' option is selected. nullable: true pend_Flag: maxLength: 1 type: string description: Indicates whether an Ex Code should be applied to claims that involve payments to the selected Provider. nullable: true phone_Country_Code: maxLength: 8 type: string description: Country code of the phone number associated with the Provider entity. nullable: true phone_Number: maxLength: 20 type: string description: Phone number associated with the Provider's rendering location. nullable: true plan_Provider: type: boolean description: This is an information field used for custom reporting. practice_Type: maxLength: 16 type: string description: Defines the type of the selected Provider. nullable: true print_Auth: type: boolean description: This is an information field used for custom reporting. provider_Type: maxLength: 10 type: string description: Identifies the type of individual Provider or Provider entity. nullable: true require_Fee_Sched: maxLength: 1 type: string description: This is an information field used for custom reporting. nullable: true sex: maxLength: 1 type: string description: Biological sex of the Provider. nullable: true soc_Sec_Number: maxLength: 10 type: string description: Social Security Number of the Provider. nullable: true sole_Proprietor: type: boolean description: 'No longer in use. This fields has been replaced by the Credentialing tables. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' specialties: maxLength: 50 type: string description: Specialty/Specialties of the individual Provider/entity. nullable: true state: maxLength: 10 type: string description: State of the rendering location. nullable: true suffix: maxLength: 20 type: string description: Suffix associated with the Provider. nullable: true upiN_Number: maxLength: 20 type: string description: This is an information field used for custom reporting. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true use_Procedure_Code: type: boolean description: 'When this option is selected, adjudication will error any of this Provider''s claims that contain revenue codes. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' website: maxLength: 128 type: string description: Website of the Provider entity. nullable: true years_Practiced: type: integer description: Number of years that the Provider has been practicing. format: int32 nullable: true zip_Code: maxLength: 32 type: string description: Zip Code of the Provider's rendering location. nullable: true additionalProperties: false ProviderAPC: required: - apply_OON - effective_Date - provider_ID - providerAPC_Key type: object properties: providerAPC_Key: type: integer description: 'Unique identifier assigned to each APC configuration record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 apC_Rate: type: number description: Rate used for APC calculations. format: double nullable: true apC_Schedule: maxLength: 16 type: string description: Allows the User to select an existing 'Ambulatory Payment Classification' schedule to base their pricing upon. These ‘APC Schedules’ need to be provided by the User and uploaded by VBA. nullable: true apply_OON: type: boolean description: 'Indicates whether the rate will be applied to Out of Network claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.' cost_To_Charge: type: number description: Cost to charge ratio used for APC calculations. format: double nullable: true effective_Date: type: string description: 'Start of the range of acceptable service dates for the modifier. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: Ex code associated with the price line. nullable: true min_Amount: type: number description: The minimum amount that can be applied to this calculation. format: double nullable: true network_ID: maxLength: 50 type: string description: The Network ID setting for this APC configuration. nullable: true provider_ID: maxLength: 20 minLength: 1 type: string description: The Provider ID associated to this APC configuration. term_Date: type: string description: End of the range of acceptable service dates for the modifier. format: date-time nullable: true trim_Point: type: number description: Trim point used for APC calculations. format: double nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true variable_Cost_Factor: type: number description: Variable cost factor used for APC calculations. format: double nullable: true additionalProperties: false ProviderAPCListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderAPC' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderAPCVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderAPC' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderAccount: required: - account_Key - provider_ID - providerAccount_Key - wire_Transfer type: object properties: providerAccount_Key: type: integer description: 'Unique identifier for each account record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 account_Key: type: integer description: 'References the FundingAccount.Account_Key record for account details. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 effective_Date: type: string description: Date when the Provider account becomes/became effective. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true provider_ID: maxLength: 20 minLength: 1 type: string description: Unique idenfitier assigned to the Proivider record. term_Date: type: string description: Date when the Provider account expires/expired. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true wire_Transfer: type: boolean description: 'Indicates if this account accepts wire transfers. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false ProviderAccountListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderAccount' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderAccountVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderAccount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderAffiliation: required: - affiliation_Provider_ID - effective_Date - provider_ID type: object properties: provider_ID: maxLength: 20 minLength: 1 type: string description: Unique idenfitier assigned to the Proivider record. affiliation_Provider_ID: maxLength: 20 minLength: 1 type: string description: Identifier of the Affiliate Provider. effective_Date: type: string description: 'Date when the Affiliate Provider status becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true term_Date: type: string description: Date when the Affiliate Provider status expires/expired. format: date-time nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false ProviderAffiliationListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderAffiliation' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderAffiliationVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderAffiliation' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderAlternate: required: - alternate_Provider_ID - effective_Date - provider_ID type: object properties: provider_ID: maxLength: 20 minLength: 1 type: string description: Unique idenfitier assigned to the Proivider record. alternate_Provider_ID: maxLength: 20 minLength: 1 type: string description: Identifier for the Alternate Provider. effective_Date: type: string description: 'Date when the Alternate Provider status becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true term_Date: type: string description: Date when the Alternate Provider status expires/expired. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderAlternateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderAlternate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderAlternateVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderAlternate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderAuthExemptProcedure: required: - from_Procedure - provider_ID - providerAuthExemptProcedure_Key type: object properties: providerAuthExemptProcedure_Key: type: integer format: int32 effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true from_Procedure: maxLength: 8 minLength: 1 type: string provider_ID: maxLength: 20 minLength: 1 type: string term_Date: type: string format: date-time nullable: true thru_Procedure: maxLength: 8 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ProviderAuthExemptProcedureListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderAuthExemptProcedure' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderAuthExemptProcedureVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderAuthExemptProcedure' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderBenefitAdmin: required: - admin_Pct - benefit_Code - effective_Date - provider_ID type: object properties: provider_ID: maxLength: 20 minLength: 1 type: string description: Unique idenfitier assigned to the Proivider record. benefit_Code: maxLength: 50 minLength: 1 type: string description: Benefit code required for adjudication matching. effective_Date: type: string description: 'Start of the range of acceptable service dates for the admin fee. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time admin_Column: maxLength: 64 type: string description: Defines what the fee percentage is taken from. This field is only used when the fee is a percentage. nullable: true admin_Fee: type: number description: Specifies the admin fee amount. format: double nullable: true admin_Pct: type: boolean description: 'Indicates that the associated fee is percentage based. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true network_ID: maxLength: 50 type: string description: This field is currently informational only. nullable: true term_Date: type: string description: End of the range of acceptable service dates for the admin fee. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderBenefitAdminListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderBenefitAdmin' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderBenefitAdminVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderBenefitAdmin' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCred: required: - credType_Key - effective_Date - provider_ID - providerCred_Key type: object properties: providerCred_Key: type: integer description: 'Unique identifier assigned to this credentialing process. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 application_Start_Date: type: string description: The date the application for this credentialing process based on the CredType. format: date-time nullable: true committee_Date: type: string description: Date when the Committee approved the credential. format: date-time nullable: true credType_Key: type: integer description: 'Identifies the type of credential. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 cred_Organization: maxLength: 512 type: string description: Indicates the organization through which the Provider was credentialed. nullable: true cred_Status: maxLength: 16 type: string description: Indicates the status of the credentialing. These status options are configured from 'Credential Status' within 'Credentialing Congifuration'. nullable: true effective_Date: type: string description: 'Date when the credentialing status becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true practice_Payee_ID: maxLength: 20 type: string description: The Payee that is associated with the Provider's credential. nullable: true practice_Send_Check_To: maxLength: 8 type: string description: Indicates where checks should be sent. This is often to the Provider themselves or to their practice. nullable: true practice_Send_Check_To_Address: maxLength: 20 type: string description: Allows the User to select from the available practice addresses if 'Practice' is selected from the 'Send Check To' option. nullable: true provider_Bio: maxLength: 1024 type: string description: Free form entry of a provider bio for the provider directory on VBAGateway. nullable: true provider_ID: maxLength: 20 minLength: 1 type: string description: Provider assigned to this credentialing process. specialty_Code: maxLength: 10 type: string description: Identifies the specialty that is associated with the Provider's credential. nullable: true term_Date: type: string description: Date when the credentialing status expires/expired. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderCredAmount: required: - amount_Pct - credAmount_Key - providerCred_Key type: object properties: providerCred_Key: type: integer description: 'Associates these custom amount values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 credAmount_Key: type: integer description: 'The type associated with the credentialing amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 amount: type: number description: The dollar amount or percentage associated with the credential. format: double nullable: true amount_Pct: type: boolean description: 'This indicates that the associated amount represents a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderCredAmountListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredAmount' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredAmountVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredAmount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredAttestation: required: - credAttestationQuestion_Key - providerCred_Key - providerCredAttestation_Key type: object properties: providerCredAttestation_Key: type: integer description: 'Unique identifier for each attestation question. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 answerDate: type: string description: Answer to the selected attestation question. format: date-time nullable: true answerNumeric: type: integer description: Answer to the selected attestation question. format: int32 nullable: true answerText: maxLength: 512 type: string description: Answer to the selected attestation question. nullable: true answerYesNo: type: boolean description: Answer to the selected attestation question. nullable: true credAttestationMethod_Key: type: integer description: Allows the User to select the method of the selected attestation question. format: int32 nullable: true credAttestationQuestion_Key: type: integer description: 'Allows the User to select a question from the available attestation questions. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 credAttestationSource_Key: type: integer description: Allows the User to select the source of the selected attestation question. format: int32 nullable: true credAttestationType_Key: type: integer description: Allows the User to select the type of the selected attestation question. format: int32 nullable: true entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 16 type: string description: Date when the record was first added to the system. nullable: true providerCred_Key: type: integer description: 'Associates these custom question values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 question_Date: type: string description: Identifies the date when the attestation question was administered. format: date-time nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 16 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false ProviderCredAttestationListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredAttestation' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredAttestationVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredAttestation' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredCertification: required: - credCertification_Key - providerCred_Key - providerCredCertification_Key type: object properties: providerCredCertification_Key: type: integer description: 'Unique identifier for each certification record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 certification_Date: type: string description: Date when the certification becomes/became effective. format: date-time nullable: true certification_Details: maxLength: 512 type: string description: Allows the User to add a description of the assocaited certification. nullable: true certification_Expiration_Date: type: string description: Date when the certification expires/expired. format: date-time nullable: true credCertification_Key: type: integer description: 'Indicates the type of certification for the credential. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true psV_Date: type: string description: Primary Source Verification date. format: date-time nullable: true providerCred_Key: type: integer description: 'Associates these custom certification values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false ProviderCredCertificationListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredCertification' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredCertificationVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredCertification' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredConfidential: required: - credConfidential_Key - providerCred_Key type: object properties: providerCred_Key: type: integer description: Associates these custom confidential values with the credentialing process (ProviderCred.ProviderCred_Key) format: int32 credConfidential_Key: type: integer description: References the CredConfidentail value for this provider. format: int32 additionalProperties: false ProviderCredConfidentialListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredConfidential' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredConfidentialVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredConfidential' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredContract: required: - credContract_Key - providerCred_Key type: object properties: providerCred_Key: type: integer description: 'Associates these custom contract values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 credContract_Key: type: integer description: 'References the CredContract value for this provider. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 discount_Percent: type: integer description: Discount associated with this contract. format: int32 nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true signature_Date: type: string description: Signature date for this contract. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderCredContractListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredContract' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredContractVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredContract' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredCounty: required: - county_Code - providerCred_Key type: object properties: providerCred_Key: type: integer description: 'Associates these custom country values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 county_Code: maxLength: 8 minLength: 1 type: string description: Code of the country where the credential is active. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderCredCountyListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredCounty' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredCountyVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredCounty' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredDate: required: - credDate_Key - effective_Date - providerCred_Key type: object properties: providerCred_Key: type: integer description: 'Associates these custom date values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 credDate_Key: type: integer description: 'Indicates the type of credentialing date. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 effective_Date: type: string description: 'Date when the associated credential becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true term_Date: type: string description: Date when the associated credential expires/expired. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderCredDateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredDate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredDateVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredDate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredEducation: required: - credEducationType_Key - providerCred_Key - providerCredEducation_Key type: object properties: providerCredEducation_Key: type: integer description: 'Unique value for each education record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 credEducationType_Key: type: integer description: 'Indicates the type of education associated with the credential. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 education_Name: maxLength: 128 type: string description: Name of the educational institution. nullable: true entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true gpa: type: number description: Grade point average of the Provider from the associated institution. format: double nullable: true graduation_Date: type: string description: Date when the Provider graduated from the associated institution. format: date-time nullable: true honors: maxLength: 256 type: string description: Identifies any honors that the Provider obtained from the assoicated institution. nullable: true providerCred_Key: type: integer description: 'Associates these custom education values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 start_Date: type: string description: Date when the Provider started their education at the associated institution. format: date-time nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false ProviderCredEducationListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredEducation' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredEducationVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredEducation' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredHours: required: - providerCred_Key - providerCredHours_Key type: object properties: providerCredHours_Key: type: integer description: 'Unique identifier for each hours record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 128 type: string description: Allows the User to create a label or short description for the set of practice/office hours. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true friday_End: type: string description: End time for Friday's credentialing hours. format: date-time nullable: true friday_Start: type: string description: Start time for Friday's credentialing hours. format: date-time nullable: true monday_End: type: string description: End time for Monday's credentialing hours. format: date-time nullable: true monday_Start: type: string description: Start time for Monday's credentialing hours. format: date-time nullable: true payee_ID: maxLength: 20 type: string description: Identifier of the Payee associated with the credentialing. nullable: true providerCred_Key: type: integer description: 'Associates these custom hours values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 saturday_End: type: string description: End time for Saturday's credentialing hours. format: date-time nullable: true saturday_Start: type: string description: Start time for Saturday's credentialing hours. format: date-time nullable: true sunday_End: type: string description: End time for Friday's credentialing hours. format: date-time nullable: true sunday_Start: type: string description: Start time for Friday's credentialing hours. format: date-time nullable: true thursday_End: type: string description: End time for Thursday's credentialing hours. format: date-time nullable: true thursday_Start: type: string description: Start time for Thursday's credentialing hours. format: date-time nullable: true tuesday_End: type: string description: End time for Tuesday's credentialing hours. format: date-time nullable: true tuesday_Start: type: string description: Start time for Tuesday's credentialing hours. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true wednesday_End: type: string description: End time for Wednesday's credentialing hours. format: date-time nullable: true wednesday_Start: type: string description: Start time for Wednesday's credentialing hours. format: date-time nullable: true additionalProperties: false ProviderCredHoursListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredHours' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredHoursVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredHours' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredHyperlink: required: - providerCred_Key - providerCredHyperlink_Key type: object properties: providerCredHyperlink_Key: type: integer description: 'Unique identifier for each hyperlink record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 display: maxLength: 256 type: string description: Indicates display order for export. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true hyperlink: maxLength: 1024 type: string description: Hyperlink associated with the Provider's credential. nullable: true providerCred_Key: type: integer description: 'Associates these custom hyperlink values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderCredHyperlinkListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredHyperlink' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredHyperlinkVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredHyperlink' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredLicense: required: - providerCred_Key - providerCredLicense_Key type: object properties: providerCredLicense_Key: type: integer description: 'Unique identifier for each license record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 credLicenseType_Key: type: integer description: Indicates the type of license associated with the credential. format: int32 nullable: true effective_Date: type: string description: Date when the license becomes/became effective. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true license_Name: maxLength: 512 type: string description: Name of the assoicated license. nullable: true license_Number: maxLength: 50 type: string description: License number of the associated license. nullable: true psV_Date: type: string description: Primary Source Verification date. format: date-time nullable: true providerCred_Key: type: integer description: 'Associates these custom license values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 specialty_Code: maxLength: 10 type: string description: Specialty associated with the license. nullable: true state: maxLength: 2 type: string description: State in which the associated license is effective. nullable: true term_Date: type: string description: Date when the license expires/expired. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderCredLicenseListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredLicense' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredLicenseVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredLicense' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCred' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredMalpractice: required: - credCarrier_Key - policy_Number - providerCred_Key type: object properties: providerCred_Key: type: integer description: 'Associates these custom carrier values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 credCarrier_Key: type: integer description: 'Identifies the malpractice insurance carrier. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 policy_Number: maxLength: 32 minLength: 1 type: string description: Policy number of the malpractice insurance. aggregate_Limit: type: number description: Aggregate limit of the malpractice policy. format: double nullable: true effective_Date: type: string description: Date when the malpractice insurance becomes/became effective. format: date-time nullable: true entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 16 type: string description: Date when the record was first added to the system. nullable: true occurrence_Amount: type: number description: Occurrence amount of the malpractice policy. format: double nullable: true specific_Limit: type: number description: Specific limit of the malpractice policy. format: double nullable: true term_Date: type: string description: Date when the malpractice insurance expires/expired. format: date-time nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 16 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false ProviderCredMalpracticeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredMalpractice' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredMalpracticeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredMalpractice' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredOption: required: - credOption_Key - providerCred_Key type: object properties: providerCred_Key: type: integer description: 'Associates these custom options values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 credOption_Key: type: integer description: 'Indicates the type of credentialing option. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true option_Result: type: integer description: Indicates the result of the credentialing option. format: int32 nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderCredOptionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredOption' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredOptionVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredOption' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredPracticeDetail: required: - credPracticeType_Key - providerCred_Key type: object properties: providerCred_Key: type: integer description: 'Associates these custom practice detail values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 credPracticeType_Key: type: integer description: 'Identifies the practice type. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 additional_Details: maxLength: 1024 type: string description: Free form entry of details for this practice record. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderCredPracticeDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredPracticeDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredPracticeDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredPracticeDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredPracticeOffice: required: - payee_ID - providerCred_Key type: object properties: providerCred_Key: type: integer description: 'Associates these custom office values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 payee_ID: maxLength: 20 minLength: 1 type: string description: Identifies the Payee ID of the office location. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderCredPracticeOfficeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredPracticeOffice' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredPracticeOfficeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredPracticeOffice' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredQuality: required: - credQuality_Key - providerCred_Key type: object properties: providerCred_Key: type: integer description: 'Associates these custom quality values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 credQuality_Key: type: integer description: 'Specifies the quality item that will be scored and rated. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true quality_Date: type: string description: Date when the quality was rated. format: date-time nullable: true quality_Rating: type: integer description: Quality rating that was given to the item. format: int32 nullable: true quality_Review: maxLength: 1024 type: string description: Free form entry of quality and review information for this record. nullable: true quality_Score: maxLength: 10 type: string description: Quality score that was given to the item. nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false ProviderCredQualityListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredQuality' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredQualityVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredQuality' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredService: required: - credService_Key - providerCred_Key type: object properties: providerCred_Key: type: integer description: 'Associates these custom service values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 credService_Key: type: integer description: 'The service being added to this credentialing process. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true percentage: type: integer description: Information Pct. Associated with this service for reporting. format: int32 nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false ProviderCredServiceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredService' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredServiceVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredService' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredTechnique: required: - credTechnique_Key - providerCred_Key type: object properties: providerCred_Key: type: integer description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 credTechnique_Key: type: integer description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: No longer in use. format: date-time entry_User: maxLength: 20 type: string description: No longer in use. nullable: true percentage: type: integer description: No longer in use. format: int32 nullable: true update_Date: type: string description: No longer in use. format: date-time update_User: maxLength: 20 type: string description: No longer in use. nullable: true additionalProperties: false ProviderCredTechniqueListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredTechnique' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredTechniqueVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredTechnique' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredTermination: required: - credTermination_Key - network_ID - providerCred_Key type: object properties: providerCred_Key: type: integer description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 network_ID: maxLength: 10 minLength: 1 type: string description: No longer in use. credTermination_Key: type: integer description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: No longer in use. format: date-time entry_User: maxLength: 20 type: string description: No longer in use. nullable: true update_Date: type: string description: No longer in use. format: date-time update_User: maxLength: 20 type: string description: No longer in use. nullable: true additionalProperties: false ProviderCredTerminationListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderCredTermination' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredTerminationVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCredTermination' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderCredVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderCred' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderDRG: required: - apply_OON - effective_Date - max_Allowed_At_Billed - provider_ID - providerDRG_Key type: object properties: providerDRG_Key: type: integer description: 'Unique identifier for each DRG configuration setting. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 apply_OON: type: boolean description: 'Indicates whether the line is applied to OON claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.' cost_To_Charge: type: number description: Cost to charge ratio used for DRG calculations. format: double nullable: true drG_Cluster: maxLength: 32 type: string description: Specifies a User-defined DRG cluster required for adjudication matching. nullable: true drG_Rate: type: number description: Rate used for DRG calculations format: double nullable: true drG_Schedule: maxLength: 16 type: string description: Allows the User to select an existing DRG schedule to base their pricing upon. These DRG Schedules need to be provided by the User and uploaded by VBA. nullable: true effective_Date: type: string description: 'Start of the range of acceptable service dates for the rate line. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: Ex code associated with the price line. nullable: true max_Allowed_At_Billed: type: boolean description: 'When selected, if the DRG rate exceeds the Bill Price, set the price to the Bill Price Note: This field is marked as NOT NULL in the database and therefore required by the API.' min_Amount: type: number description: 'If the total billed amount is greater than or equal to the ‘Outlier Amount’, the ‘Outlier Type’ calculation is considered.' format: double nullable: true network_ID: maxLength: 50 type: string description: Identifies the required Network for adjudication matching. nullable: true outlier_Type: maxLength: 1 type: string description: This indicates the outlier calculation to be performed as part of the DRG calculation. nullable: true provider_ID: maxLength: 20 minLength: 1 type: string description: The Provider ID this DRG setting is being applied. term_Date: type: string description: End of the range of acceptable service dates for the rate line. format: date-time nullable: true trim_Point: type: number description: Trim point used for DRG calculations. format: double nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true variable_Cost_Factor: type: number description: Variable cost factor used for DRG calculations. format: double nullable: true additionalProperties: false ProviderDRGListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderDRG' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderDRGVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderDRG' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderLanguages: required: - language_ID - primary_Language - provider_ID - secondary_Language type: object properties: provider_ID: maxLength: 20 minLength: 1 type: string description: Unique idenfitier assigned to the Proivider record. language_ID: maxLength: 8 minLength: 1 type: string description: Name of the language. entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true language_Skill_Level: maxLength: 1 type: string description: Indicates the fluency of the Provider in the selected language. nullable: true primary_Language: type: boolean description: 'Indicates that the selected language is the Provider''s primary language. Note: This field is marked as NOT NULL in the database and therefore required by the API.' secondary_Language: type: boolean description: 'Indicates that the selected language is a secondary language for the Provider. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false ProviderLanguagesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderLanguages' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderLanguagesVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderLanguages' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Provider' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderNetwork: required: - eff_Date - network_ID - provider_ID - use_No_Proc_In_Fee type: object properties: provider_ID: maxLength: 20 minLength: 1 type: string description: Unique idenfitier assigned to the Proivider record. network_ID: maxLength: 10 minLength: 1 type: string description: Indicates which Network the options will be associated with. eff_Date: type: string description: 'Start of the range of acceptable service dates for the network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time claim_Days_Allowed: type: integer description: No longer in use. format: int32 nullable: true disc_Pct: type: number description: Indicates the discount percentage that will be applied to the selected fee schedule. format: double nullable: true disc_Pct_2: type: number description: The Discount Percentage for the Secondary Fee Schedule format: double nullable: true entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true fee_Sched: maxLength: 8 type: string description: Allows the User to select an existing fee schedule to base their pricing upon. nullable: true fee_Sched_2: maxLength: 8 type: string description: 'If the primary Fee Schedule for the Provider Network does not match, attempt to match on this Secondary Fee Schedule' nullable: true no_Proc_In_Fee_Disc_Pct: type: number description: This is the adjustment percentage that will be used if the 'Use Not in Fee Adj.' option is selected. format: double nullable: true priority: type: integer description: Indicates the network-level priority of the Provider's network affiliation. This priority is used in the adjudication calculation to assign networks. The network with the lowest sum (network level priority + group level priority) will be assigned. format: int32 nullable: true reason_Comment: maxLength: 1024 type: string description: Allows the User to add any relevant notes regarding the reason for termination. nullable: true reason_ID: type: integer description: Indicates the reason for termination of the associated network. format: int32 nullable: true term_Date: type: string description: End of the range of acceptable service dates for the network. format: date-time nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true use_No_Proc_In_Fee: type: boolean description: 'If a procedure code match can not be found in the selected fee schedule, adjudication will use a flat adjustment percentage instead. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false ProviderNetworkListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderNetwork' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderNetworkModifier: required: - effective_Date - modifier - network_ID - provider_ID type: object properties: provider_ID: maxLength: 20 minLength: 1 type: string description: Identifier of the Proivider record. network_ID: maxLength: 50 minLength: 1 type: string description: Indicates which Network the options will be associated with. modifier: maxLength: 8 minLength: 1 type: string description: This is the modifier assigned to this configuration. When blank it indicates all modifiers. effective_Date: type: string description: 'Date when the associated modifier becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true fee_Percent: type: number description: Fee percentage that will be applied with the modifier. Negative values may be used to apply discounts. format: double nullable: true term_Date: type: string description: Date when the associated modifier expires/expired. format: date-time nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false ProviderNetworkModifierListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderNetworkModifier' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderNetworkModifierVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderNetworkModifier' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderNetworkVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderNetwork' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderPayee: required: - effective_Date - payee_ID - provider_ID type: object properties: provider_ID: maxLength: 20 minLength: 1 type: string description: Identifier of Proivider record. payee_ID: maxLength: 20 minLength: 1 type: string description: Idenfifier of the Provider Payee. effective_Date: type: string description: 'Date when the Payee becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time blid: maxLength: 64 type: string description: BaseLoad Key for this Service/Billing Provider location combination. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true term_Date: type: string description: Date when the Payee expires/expired. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderPayeeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderPayee' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderPayeeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderPayee' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderPerDiem: required: - apply_OON - effective_Date - eR_Rate - inpatient - provider_ID - providerPerDiem_Key - unit_Based type: object properties: providerPerDiem_Key: type: integer description: 'Unique identifier for each Per Diem configuration setting. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 apply_OON: type: boolean description: 'Identifies that the claim must be OON for adjudication matching. Note: This field is marked as NOT NULL in the database and therefore required by the API.' drG_Cluster: maxLength: 32 type: string description: Identifies that the DRG within the claim falls within this cluster for adjudication matching. nullable: true eR_Rate: type: boolean description: 'Identifies that ER services are required for adjudication matching. Note: This field is marked as NOT NULL in the database and therefore required by the API.' effective_Date: type: string description: 'Start of the range of acceptable service dates for the rate line. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time end_Date: type: string description: End of the range of acceptable service dates for the rate line. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: Ex code associated with the price line. nullable: true inpatient: type: boolean description: 'Identifies that inpatient services are required for adjudication matching. Note: This field is marked as NOT NULL in the database and therefore required by the API.' max_Days: type: integer description: Maximum number of days allowed for the rate to be applied. format: int32 nullable: true min_Days: type: integer description: Minimum number of days required for the rate to be applied. format: int32 nullable: true network_ID: maxLength: 10 type: string description: Identifies the required Network for adjudication matching. nullable: true perDiem_Rate: type: number description: Per day rate associated with the rate line. format: double nullable: true provider_ID: maxLength: 20 minLength: 1 type: string description: Unique idenfitier assigned to the Proivider record. unit_Based: type: boolean description: 'Indicates whether the rate is per unit. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderPerDiemListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderPerDiem' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderPerDiemProcedure: required: - from_Procedure - providerPerDiem_Key - thru_Procedure type: object properties: providerPerDiem_Key: type: integer format: int32 from_Procedure: maxLength: 8 minLength: 1 type: string thru_Procedure: maxLength: 8 minLength: 1 type: string entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ProviderPerDiemProcedureListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderPerDiemProcedure' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderPerDiemProcedureVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderPerDiemProcedure' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderPerDiemVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderPerDiem' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderProfile: required: - address_Provider_ID - profile_Provider_ID - providerProfile_Key type: object properties: providerProfile_Key: type: integer description: Unique identifier for each Provider Profile record. format: int32 address_Provider_ID: maxLength: 20 minLength: 1 type: string description: The referenced dependent or "Address" provider record. profile_Provider_ID: maxLength: 20 minLength: 1 type: string description: The referenced parent or "Profile" provider record. additionalProperties: false ProviderProfileVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderProfile' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderRate: required: - addOnRateDRG - addOnRatePerDiem - inpatient - outpatient - provider_ID - providerRate_Key - rate_Percent type: object properties: providerRate_Key: type: integer description: Unique identifier for each Rate setting. format: int32 addOnRateDRG: type: boolean description: Indicates that this line is added onto an existing ‘DRG’ rate. addOnRatePerDiem: type: boolean description: Indicates that this line is added onto an existing ‘Per Diem’ rate. effective_Date: type: string description: Start of the range of acceptable service dates for the rate line. format: date-time nullable: true end_Date: type: string description: End of the range of acceptable service dates for the rate line. format: date-time nullable: true ex_Code: maxLength: 6 type: string description: Ex code associated with the price line. nullable: true inpatient: type: boolean description: Indicates whether the associated rate is applied to inpatient services. outpatient: type: boolean description: Indicates whether the associated rate is applied to outpatient services. percent_Type: maxLength: 1 type: string description: No longer in use. nullable: true provider_ID: maxLength: 20 minLength: 1 type: string description: Unique idenfitier assigned to the Proivider record. rate: type: number description: Rate used in price calculations. format: double nullable: true rate_Percent: type: boolean description: Tells the system to read the rate as a percentage instead of flat rate. rate_Type: maxLength: 1 type: string description: 'Determines how the selected rate is applied: Per Service Line – applies the associated rate to each service line that matches the defined criteria. All Service Lines – if any line within a claim matches the criteria, the associated rate is applied to ALL service lines on the claim. Per Unit – multiplies the rate by the number of units on the matching service line. Case Rate – treats the entire claim like a case. The ‘Case Rate’ is applied to an available matching line, and all other service lines are repriced to zero dollars. Only ONE ‘Case Rate’ is allowed per claim. If multiple service lines match a ‘Case Rate’, the claim will error. ASC Grouper – treats the entire claim like case. The ‘ASC Grouper Rate’ is applied to ALL available matching lines, and all other service lines are repriced to zero dollars. This rate is like ‘Case Rate’, but it allows the matching of multiple service lines.' nullable: true additionalProperties: false ProviderRateAdjust: required: - adjust_Seq - providerRate_Key - providerRateAdjust_Key type: object properties: providerRateAdjust_Key: type: integer description: 'References the ProviderRate.ProviderRate_Key value on the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 adjust_Pct: type: number description: Desired adjustment percentage. format: double nullable: true adjust_Repeat: type: integer description: Number of times the adjustment can be repeated before progressing to the next sequence. format: int32 nullable: true adjust_Rule: maxLength: 16 type: string description: This indicates if a special rule option is being implemented during rate calculation. This is defined between the client and VBA to determine the custom process. nullable: true adjust_Seq: type: integer description: 'Unique sequential identifier. Adjustments will be applied in sequential order. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true providerRate_Key: type: integer description: 'Unique identifier for this Rate Adjustments configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false ProviderRateAdjustListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderRateAdjust' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderRateAdjustVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderRateAdjust' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderRateColumn: required: - providerRateColumn_Key type: object properties: providerRateColumn_Key: type: integer description: Unique identifier for each Rate Column value. format: int32 data_Type: maxLength: 32 type: string description: The data type of the column. nullable: true description: maxLength: 128 type: string description: Description of the column being added to ProviderRateCriteria. nullable: true search_Object: maxLength: 128 type: string description: Indicates if there is a VBASoftware search object associated with this column. This field is only used with our Legacy VBASoftware program. nullable: true additionalProperties: false ProviderRateColumnListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderRateColumn' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderRateColumnVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderRateColumn' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderRateCriteria: required: - providerRate_Key - providerRateColumn_Key - providerRateCriteria_Key type: object properties: providerRateCriteria_Key: type: integer description: References. The ProviderRateCriteria.ProviderRateCriteria_Key value on the parent table. format: int32 criteria_From: maxLength: 64 type: string description: Beginning of selected criteria range. nullable: true criteria_Operator: maxLength: 1 type: string description: 'Defines how the ‘From’ and ‘Thru’ range is treated: inclusive, exclusive, matching, etc.' nullable: true criteria_Thru: maxLength: 64 type: string description: End of selected criteria range. This criterion is only used for the ‘Between’ operation. nullable: true providerRateColumn_Key: type: integer description: References the ProviderRateColumn.ProviderRateColumn_Key on the parent table. format: int32 providerRate_Key: type: integer description: References the ProviderRate.ProviderRate_Key value on the parent table. format: int32 additionalProperties: false ProviderRateCriteriaListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderRateCriteria' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderRateCriteriaVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderRateCriteria' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderRateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderRate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderRateVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderRate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderRole: required: - provider_Role_ID type: object properties: provider_Role_ID: maxLength: 20 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ProviderRoleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderRole' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderRoleVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderRole' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderSpecialty: required: - provider_ID - specialty_Code type: object properties: provider_ID: maxLength: 20 minLength: 1 type: string description: Unique idenfitier assigned to the Proivider record. specialty_Code: maxLength: 10 minLength: 1 type: string description: References the Specialty.Specialty_Code value on the referenced table. additionalProperties: false ProviderSpecialtyListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderSpecialty' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderSpecialtyVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderSpecialty' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderSuffix: required: - provider_ID - suffix type: object properties: provider_ID: maxLength: 20 minLength: 1 type: string description: Unique idenfitier assigned to the Proivider record. suffix: maxLength: 16 minLength: 1 type: string description: Suffix associated with the Provider. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderSuffixListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderSuffix' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderSuffixVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderSuffix' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderTaxonomy: required: - provider_ID - providerTaxonomy_Key - taxonomy_Code type: object properties: providerTaxonomy_Key: type: integer description: 'Unique identifier for each taxonomy value for this Provider. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true provider_ID: maxLength: 20 minLength: 1 type: string description: Unique idenfitier assigned to the Proivider record. taxonomy_Code: maxLength: 32 minLength: 1 type: string description: Taxonomy Code assigned to this Provider. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderTaxonomyListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderTaxonomy' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderTaxonomyVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderTaxonomy' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderTypes: required: - provider_Type type: object properties: provider_Type: maxLength: 10 minLength: 1 type: string description: Name of the Provider type. all_Providers: maxLength: 1 type: string description: Indicates that the selected Provider type encompasses all other types. nullable: true care_Manager: maxLength: 1 type: string description: Indicates that the selected Provider type is a care manager. nullable: true cred_Type: maxLength: 10 type: string description: No longer in use. nullable: true description: maxLength: 50 type: string description: Description of the Provider type. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true hospital: maxLength: 1 type: string description: Indicates that the selected Provider type is associated with hospital services. nullable: true inpatient: maxLength: 1 type: string description: Indicates that the selected Provider type is associated with inpatient services. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false ProviderTypesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderTypes' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderTypesVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderTypes' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderVBAResponse: type: object properties: data: $ref: '#/components/schemas/Provider' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderWithhold: required: - effective_Date - providerWithhold_Key - withhold_Pct type: object properties: providerWithhold_Key: type: integer description: Unique identifier for each Withhold setting. format: int32 account_Key: type: integer description: This field indicates the funding account criteria by which the withhold is applied to a claim. format: int32 nullable: true benefit_Code: maxLength: 10 type: string description: Benefit code required for adjudication matching. nullable: true effective_Date: type: string description: Start of the range of acceptable service dates for the admin fee. format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: Ex code associated with the price line. nullable: true federal_ID: maxLength: 20 type: string description: Allows setting the Tax ID that this withhold will apply when applying a withhold across multiple Providers. nullable: true network_ID: maxLength: 10 type: string description: Identifies the required Network for adjudication matching. nullable: true payor_ID: maxLength: 20 type: string description: This field indicates the payor criteria by which the withhold is applied to a claim. nullable: true provider_ID: maxLength: 20 type: string description: The Provider ID this Withhold setting is being applied. nullable: true term_Date: type: string description: End of the range of acceptable service dates for the admin fee. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true withhold: type: number description: Shows the withheld percentage. format: double nullable: true withhold_Max: type: number description: Indicates the max Withhold that can be taken for this withhold configuration. format: double nullable: true withhold_Pct: type: boolean description: Indicates if the Withhold value on this table is a Percentage or a Flat amount. additionalProperties: false ProviderWithholdListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderWithhold' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ProviderWithholdVBAResponse: type: object properties: data: $ref: '#/components/schemas/ProviderWithhold' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Purpose: required: - description - name type: object properties: name: minLength: 1 type: string description: Unique name of the Purpose description: minLength: 1 type: string description: Description of the Purpose additionalProperties: false PurposeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Purpose' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Reasons: required: - reason_ID type: object properties: reason_ID: type: integer description: 'Identifier for a specific enrollment change Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 cobrA_Length: type: integer description: Time period for COBRA election format: int32 nullable: true cobrA_Length_Type: maxLength: 32 type: string description: Units of the time period for COBRA election nullable: true description: maxLength: 50 type: string description: Description for a specific enrollment change nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true hipaA_Code: maxLength: 8 type: string description: HIPAA code associate with the reason nullable: true hsrS_Code: maxLength: 2 type: string description: Human Services Reporting System code associated with the reason nullable: true reason_Type: maxLength: 32 type: string description: 'Specifies if the reason is a qualifying event, standard reason or not specified' nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReasonsListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Reasons' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReasonsVBAResponse: type: object properties: data: $ref: '#/components/schemas/Reasons' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false RecentlyVisited: type: object properties: object_Title: type: string nullable: true display_Text: type: string nullable: true visited_Date: type: string format: date-time additionalProperties: false RecentlyVisitedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/RecentlyVisited' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReimburseSchedule: required: - reimburse_Schedule type: object properties: reimburse_Schedule: maxLength: 32 minLength: 1 type: string description: maxLength: 128 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true schedule_Frequency: type: integer format: int32 nullable: true schedule_Type: maxLength: 1 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false ReimburseScheduleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReimburseSchedule' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReimburseScheduleVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReimburseSchedule' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsAccum: required: - claim_Number - member_Seq - reinsContract_Key - subscriber_ID type: object properties: reinsContract_Key: type: integer description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 subscriber_ID: maxLength: 9 minLength: 1 type: string description: No longer in use. member_Seq: maxLength: 2 minLength: 1 type: string description: No longer in use. claim_Number: type: integer description: 'No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 batch_Claim: type: integer description: No longer in use. format: int32 nullable: true batch_Number: type: integer description: No longer in use. format: int32 nullable: true billed_Price: type: number description: No longer in use. format: double nullable: true co_Ins_Amt: type: number description: No longer in use. format: double nullable: true co_Pay_Amt: type: number description: No longer in use. format: double nullable: true deductible_Amt: type: number description: No longer in use. format: double nullable: true entry_Date: type: string description: No longer in use. format: date-time entry_User: maxLength: 20 type: string description: No longer in use. nullable: true not_Covered_Amt: type: number description: No longer in use. format: double nullable: true paid_Amt: type: number description: No longer in use. format: double nullable: true plan_Price: type: number description: No longer in use. format: double nullable: true reinsCriteria_Type: maxLength: 16 type: string description: No longer in use. nullable: true running_Total: type: number description: No longer in use. format: double nullable: true update_Date: type: string description: No longer in use. format: date-time update_User: maxLength: 20 type: string description: No longer in use. nullable: true additionalProperties: false ReinsAccumListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsAccum' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsAccumVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsAccum' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContract: required: - adjudicate_Threshold_Pct - enroll_Disenroll_By_On_Agg_Report - reinsContract_Key - spec_Threshold_Notify - specific_Deductible_Family - specific_Reporting_Threshold_Pct - template_Contract - use_Reins_Level type: object properties: reinsContract_Key: type: integer description: 'Unique identifier for each Reinsurance Contract. This is system generated. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 adjudicate_Threshold: type: number description: Notes the threshold for when a member will have an ex code applied to their claim as they incur more claims against this contract. format: double nullable: true adjudicate_Threshold_Ex_Code: maxLength: 6 type: string description: The ex code that is applied to claims for members who exceed the adjudication threshold. nullable: true adjudicate_Threshold_Pct: type: boolean description: 'Notes if the "Adjudicate Threshold" is a percentage or flat value. Note: This field is marked as NOT NULL in the database and therefore required by the API.' aggregate_Max: type: number description: The aggregating Spec. Max for all members on this Reinsurance Contract. format: double nullable: true aggregate_Specific_Deductible: type: number description: The aggregating Spec. Deductible for all members on this Reinsurance Contract. format: double nullable: true attachment_Minimum: type: number description: The attachment point for reinsurance reporting. format: double nullable: true attachment_Minimum_Term: maxLength: 1 type: string description: Notes if the attachment minimu is a monthly or annual value. nullable: true carrier_Key: type: integer description: References the Carrier.Carrier_Key value on referenced table. format: int32 nullable: true contract_Cycle: maxLength: 32 type: string description: User defined contract period from the ReinsContractCycle table. nullable: true contract_ID: maxLength: 64 type: string description: The contract ID assigned by the client to this Reinsurance Contract. nullable: true contract_Level: maxLength: 1 type: string description: 'Contract Level notes what level the members and claims on this contract are included. The level can be Group, Division or Subscriber.' nullable: true contract_Status: maxLength: 32 type: string description: 'The status of the contract, Open or Closed.' nullable: true contract_Type: maxLength: 32 type: string description: 'The type of contractly, typically a 12/12 or 12/24 contract.' nullable: true description: maxLength: 512 type: string description: The description of this Reinsurance Contract. nullable: true disenrolled_By_Day: type: integer description: Impacts how eligiblity is calculated when determining if a member applies to this contract. format: int32 nullable: true division_ID: maxLength: 20 type: string description: 'When contract Level is Division, this is the Division (in combination with Group) that is applicable to this Reinsurance Contract.' nullable: true domestic_Claim_Criteria_Key: type: integer format: int32 nullable: true effective_Date: type: string description: The effective date of this Reinsurance Contract. Used in reporting and transaction processing. format: date-time nullable: true enroll_Disenroll_By_On_Agg_Report: type: boolean description: 'Used in custom reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.' enrolled_By_Day: type: integer description: Impacts how eligiblity is calculated when determining if a member applies to this contract. format: int32 nullable: true enrollment_Baseline: type: integer description: Used in custom reporting. format: int32 nullable: true enrollment_Change_Threshold: type: number description: Used in custom reporting. format: double nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true group_ID: maxLength: 20 type: string description: 'When contract Level is Group, this is the Group that is applicable to this Reinsurance Contract.' nullable: true policy_Number: maxLength: 64 type: string description: The policy number associated with this Reinsurance Contract. nullable: true reimburse_Method: maxLength: 32 type: string description: Notes if this is "Spec. Advance Fund" where all claims are included or "Pay and Reimburse" where only paid claims are included in the calculation. nullable: true spec_Threshold_Notify: type: boolean description: 'Indicates if an Event should be generated and user or group notified when the threshold has been exceeded. Note: This field is marked as NOT NULL in the database and therefore required by the API.' specific_Deductible: type: number description: The individual member Spec. Deductible for this Reinsurance Contract. format: double nullable: true specific_Deductible_Family: type: boolean description: 'The family Spec. Deductible for this Reinsurance Contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.' specific_Max: type: number description: The Spec. Limit for this Reinsurance Contract. format: double nullable: true specific_Reporting_Threshold: type: number description: Notes the threshold for when a member will be considered part of the Member Loss report. format: double nullable: true specific_Reporting_Threshold_Pct: type: boolean description: 'Notes if the Specific_Reporting_Threshold value is a percentage or set value. Note: This field is marked as NOT NULL in the database and therefore required by the API.' state_Minimum: type: number description: The individual state attachment minimum for reporting based on the state of the member. format: double nullable: true subscriber_ID: maxLength: 9 type: string description: 'When contract Level is Subscriber, this is the Subscriber (in combination with Group and Division) that is applicable to this Reinsurance Contract.' nullable: true template_Contract: type: boolean description: 'Allows the user to create a template contract that can then be "copied" whenever new contracts are created. Note: This field is marked as NOT NULL in the database and therefore required by the API.' term_Date: type: string description: The term date of this Reinsurance Contract. Used in reporting and transaction processing. format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true use_Reins_Level: type: boolean description: 'Indicates if this contract uses "Reinsurance Levels" for Reinsurance Calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false ReinsContractAggSpecMember: required: - member_Seq - reinsContract_Key - subscriber_ID type: object properties: reinsContract_Key: type: integer description: References the ReinsContract.ReinsContract_Key on parent table. This holds the list of members who form the aggregating specific. format: int32 subscriber_ID: maxLength: 9 minLength: 1 type: string description: The member that is part of the aggregating specific deductible. member_Seq: maxLength: 2 minLength: 1 type: string description: The member that is part of the aggregating specific deductible. additionalProperties: false ReinsContractAggSpecMemberListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractAggSpecMember' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractAggSpecMemberVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractAggSpecMember' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractConditionalSpecific: required: - reinsContract_Key - reinsContractConditionalSpecific_Key type: object properties: reinsContractConditionalSpecific_Key: type: integer description: 'Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string nullable: true display: maxLength: 64 type: string nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true reinsContract_Key: type: integer description: 'Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 specific_Deductible: type: number format: double nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsContractConditionalSpecificDetail: required: - exclude - reinsContractConditionalSpecific_Key - reinsContractConditionalSpecificDetail_Key - use_Diagnostic_Group type: object properties: reinsContractConditionalSpecificDetail_Key: type: integer description: 'Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 diagnostic_Code_Type: maxLength: 16 type: string nullable: true diagnostic_Group: maxLength: 32 type: string nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true exclude: type: boolean description: 'Note: This field is marked as NOT NULL in the database and therefore required by the API.' from_Diag_Code: maxLength: 8 type: string nullable: true reinsContractConditionalSpecific_Key: type: integer description: 'Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 thru_Diag_Code: maxLength: 8 type: string nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true use_Diagnostic_Group: type: boolean description: 'Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false ReinsContractConditionalSpecificDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractConditionalSpecificDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractConditionalSpecificDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractConditionalSpecificListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractConditionalSpecific' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractConditionalSpecificVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractConditionalSpecific' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractCriteria: required: - criteria_Type - reinsContract_Key - reinsContractCriteria_Key type: object properties: reinsContractCriteria_Key: type: integer description: 'Unique identifier for each criteria on this contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 criteria_Type: maxLength: 16 minLength: 1 type: string description: Indicates if this is a Spec or Agg criteria. entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true incurred_From: type: string description: The incurred (service date) from. format: date-time nullable: true incurred_Thru: type: string description: The incurred (service date) thru. format: date-time nullable: true paid_From: type: string description: The paid (check run date) from. format: date-time nullable: true paid_Thru: type: string description: The paid (check run date) thru. format: date-time nullable: true reinsContract_Key: type: integer description: 'References the ReinsContract.ReinsContract_Key on parent table. This holds the Spec or Agg Inccurred/Paid ranges that create the basis for claims being attached to transactions. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsContractCriteriaDetail: required: - criteria_Exclude - reinsContractCriteria_Key - reinsContractCriteriaDetail_Key type: object properties: reinsContractCriteriaDetail_Key: type: integer description: 'Unique identifier for each criteria detail on this criteria. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 criteria_Exclude: type: boolean description: 'Indicates if the range entered is an exclusion range. Note: This field is marked as NOT NULL in the database and therefore required by the API.' criteria_Field: maxLength: 128 type: string description: 'The field that is part of the criteria (such as benefit, procedure code, diag code, etc.)' nullable: true criteria_Value_From: maxLength: 128 type: string description: The range for this Criteria_Field. nullable: true criteria_Value_Thru: maxLength: 128 type: string description: The range for this Criteria_Field. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true reinsContractCriteria_Key: type: integer description: 'References ReinsContractCriteria.ReinsContractCriteria_Key on parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsContractCriteriaDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractCriteriaDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractCriteriaDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractCriteriaDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractCriteriaListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractCriteria' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractCriteriaVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractCriteria' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractCycle: required: - contract_Cycle type: object properties: contract_Cycle: maxLength: 32 minLength: 1 type: string description: Unique identifier for each Contract Cycle. cycle_Frequency: type: integer description: The frequency for this reinsurance cycle based on Cycle_Type. format: int32 nullable: true cycle_Type: maxLength: 1 type: string description: 'In combination with Cycle_Frequency, dertermines the reinsurance cycle.' nullable: true description: maxLength: 128 type: string description: The description for this cycle. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsContractCycleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractCycle' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractCycleVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractCycle' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractFactor: required: - effective_Date - reinsContract_Key - reinsContractFactor_Key - tier type: object properties: reinsContractFactor_Key: type: integer description: 'Unique identifier for each contract factor configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 age_From: type: integer description: The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation. format: int32 nullable: true age_Thru: type: integer description: The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation. format: int32 nullable: true effective_Date: type: string description: 'The effective date of this factor within the reinsurance contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true factor: type: number description: The calculated factor for each eligiblity member that falls into this configuration. format: double nullable: true plan_ID: maxLength: 20 type: string description: The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation. nullable: true reinsContract_Key: type: integer description: 'References the ReinsContract.ReinsContract_Key on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 term_Date: type: string description: The term date of this factor within the reinsurance contract. format: date-time nullable: true tier: maxLength: 2 minLength: 1 type: string description: The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation. update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true zip_From: maxLength: 32 type: string description: The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation. nullable: true zip_Thru: maxLength: 32 type: string description: The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation. nullable: true additionalProperties: false ReinsContractFactorCriteria: required: - criteria_Exclude - reinsContract_Key - reinsContractFactorCriteria_Key type: object properties: reinsContractFactorCriteria_Key: type: integer description: 'Unique identifier for each contract factor criteria. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 criteria_Exclude: type: boolean description: 'Indicates if the range entered is an exclusion range. Note: This field is marked as NOT NULL in the database and therefore required by the API.' criteria_Field: maxLength: 128 type: string description: 'The field that is part of the criteria (such as benefit, procedure code, diag code, etc.)' nullable: true criteria_Value_From: maxLength: 128 type: string description: The range for this Criteria_Field. nullable: true criteria_Value_Thru: maxLength: 128 type: string description: The range for this Criteria_Field. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true reinsContract_Key: type: integer description: 'References the ReinsContract.ReinsContract_Key on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsContractFactorCriteriaListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractFactorCriteria' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractFactorCriteriaVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractFactorCriteria' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractFactorListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractFactor' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractFactorVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractFactor' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContract' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractMemberSpecific: required: - member_Seq - reinsContract_Key - subscriber_ID type: object properties: reinsContract_Key: type: integer description: 'Refernces the ReinsContract.ReinsContract_Key on parent record. Each value is a laser deductible for a member on this contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 subscriber_ID: maxLength: 9 minLength: 1 type: string description: The member that is identified for this laser deductible. member_Seq: maxLength: 2 minLength: 1 type: string description: The member that is identified for this laser deductible. entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true specific_Deductible: type: number description: The lasered deductible to be carved out within this contract. format: double nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsContractMemberSpecificListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractMemberSpecific' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractMemberSpecificVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractMemberSpecific' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractNotifyGroup: required: - reinsContract_Key - userGroup_Key type: object properties: reinsContract_Key: type: integer description: 'References the ReinsContract.ReinsContract_Key on parent record. When notification is enabled for the reinsurance contract, this notes which user group to notify.' format: int32 userGroup_Key: type: integer description: The user group to be notified. format: int32 additionalProperties: false ReinsContractNotifyGroupListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractNotifyGroup' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractNotifyGroupVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractNotifyGroup' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractNotifyUser: required: - reinsContract_Key - user_ID type: object properties: reinsContract_Key: type: integer description: 'References the ReinsContract.ReinsContract_Key on parent record. When notification is enabled for the reinsurance contract, this notes which user to notify.' format: int32 user_ID: maxLength: 20 minLength: 1 type: string description: The user to be notified. additionalProperties: false ReinsContractNotifyUserListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractNotifyUser' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractNotifyUserVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractNotifyUser' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractStatus: required: - contract_Status type: object properties: contract_Status: maxLength: 32 minLength: 1 type: string description: Unique value for each contract status. description: maxLength: 128 type: string description: The description for this contract status. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsContractStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTemplate: required: - contract_Key - templateContract_Key type: object properties: templateContract_Key: type: integer description: Unique identifier for each templat configuration. format: int32 contract_Key: type: integer description: Used when configuring the template contract. format: int32 additionalProperties: false ReinsContractTemplateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractTemplate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTemplateVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractTemplate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTrans: required: - reinsContract_Key - reinsContractTrans_Key type: object properties: reinsContractTrans_Key: type: integer description: 'Unique identifier for each transaction being generated on this contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: The description of this transaction. nullable: true entry_Date: type: string description: User that first added the record to the system format: date-time entry_User: maxLength: 20 type: string description: Date record was first added to the system nullable: true member_Seq: maxLength: 2 type: string description: The member on this transaction. nullable: true reinsContract_Key: type: integer description: 'References the ReinsContract.ReinsContract_Key on parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 submitted_Date: type: string description: The date the reinsurance claims (transaction) was submitted to the reinsurance carrier. format: date-time nullable: true subscriber_ID: maxLength: 9 type: string description: The member on this transaction. nullable: true transaction_Amount: type: number description: The total amount of the claims attached to this transaction. format: double nullable: true transaction_Claim_Number: maxLength: 64 type: string description: The transaction ID associated with this reinsurance claim. nullable: true transaction_Date: type: string description: The date the transaction was generated. format: date-time nullable: true transaction_Status: maxLength: 32 type: string description: The status of this transaction as it is in the process of being reimbursed. nullable: true transaction_Type: maxLength: 32 type: string description: The type of transaction being created. This is a spec transaction or agg transaction. nullable: true update_Date: type: string description: User that last updated the record in the system format: date-time update_User: maxLength: 20 type: string description: Date the record was last updated in the system nullable: true additionalProperties: false ReinsContractTransClaim: required: - claim_Number - reinsContractTrans_Key type: object properties: reinsContractTrans_Key: type: integer description: 'References the ReinsContractTrans.ReinsContractTrans_Key on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 claim_Number: type: integer description: 'The claim (Claim.Claim_Number) that is part of this reinsurance transaction. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 aggSpecDed_Reimbursed: type: number description: The amount of this claim being applied to the aggregating spec deductible if any. format: double nullable: true claimTransaction_Not_Covered: type: number description: The amount of this claim not covered by the reinsurance carrier. format: double nullable: true claimTransaction_Reimbursed: type: number description: The amount of this claim being reimbursed. format: double nullable: true claimTransaction_Status: maxLength: 32 type: string description: The status of this claim on the transaction. nullable: true claim_Paid_Amount_On_Trans: type: number description: The paid amount of the claim. format: double nullable: true entry_Date: type: string description: User that first added the record to the system format: date-time entry_User: maxLength: 20 type: string description: Date record was first added to the system nullable: true specDed_Reimbursed: type: number description: The amount of this claim being applied to the spec deductible if any. format: double nullable: true update_Date: type: string description: User that last updated the record in the system format: date-time update_User: maxLength: 20 type: string description: Date the record was last updated in the system nullable: true domestic_Claim: type: boolean criteria_Key: type: integer format: int32 nullable: true domestic_Reduction_Pct: type: number format: double nullable: true additionalProperties: false ReinsContractTransClaimDetail: required: - claim_Number - reinsContractTrans_Key - reinsContractTransClaimDetail_Key type: object properties: reinsContractTransClaimDetail_Key: type: integer description: 'Unique identifer for each claim reinsurance level. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 benefit_Code: maxLength: 10 type: string description: The benefit codes on the associated claim that are part of this reinsurance level. nullable: true claim_Number: type: integer description: 'The claim that is part of this reinsurance level. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 deductible_Pct: type: number description: The reinsurance level deductible percent applied on this specific claim. format: double nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true paid_Amt: type: number description: The paid amount of the claim. format: double nullable: true reinsContractTrans_Key: type: integer description: 'References the ReinsContract.ReinsContract_Key on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 reins_Level_From: type: number description: The reinsurance level range. format: double nullable: true reins_Level_Thru: type: number description: The reinsurance level range. format: double nullable: true reins_Paid: type: number description: The amount reinsurance has paid for this claim at this reinsurance level. format: double nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsContractTransClaimDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractTransClaimDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTransClaimDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractTransClaimDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTransClaimListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractTransClaim' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTransClaimStatus: required: - claimTransaction_Status type: object properties: claimTransaction_Status: maxLength: 32 minLength: 1 type: string description: Unique identifier for each Claim transaction status. description: maxLength: 128 type: string description: The description of this claim transaction status. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsContractTransClaimStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractTransClaimStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTransClaimStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractTransClaimStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTransClaimVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractTransClaim' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTransListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractTrans' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTransReimburse: required: - funding_Key - reinsContractTrans_Key - reinsContractTransReimburse_Key type: object properties: reinsContractTransReimburse_Key: type: integer description: 'Unique identifier for each funding item used to reimburse claims on this reinsurance transaction. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true funding_Key: type: integer description: 'References the Funding.Funding_Key for this reimbursement. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 reinsContractTrans_Key: type: integer description: 'References the ReinsContractTrans.ReinsContractTrans_Key on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsContractTransReimburseListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractTransReimburse' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTransReimburseVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractTransReimburse' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTransStatus: required: - transaction_Status type: object properties: transaction_Status: maxLength: 32 minLength: 1 type: string description: Unique identifier for each transaction status. description: maxLength: 128 type: string description: The description for this transaction status. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsContractTransStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractTransStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTransStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractTransStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTransVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractTrans' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractType: required: - contract_Type type: object properties: contract_Type: maxLength: 32 minLength: 1 type: string description: Unique identifier for each contract type. description: maxLength: 128 type: string description: Description for this contract type. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsContractTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsContractType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContractType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsContractVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsContract' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsDomesticClaimCriteria: required: - reinsDomesticClaimCriteria_Key type: object properties: reinsDomesticClaimCriteria_Key: type: integer description: 'Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 claim_Reduction_Pct: type: number format: double nullable: true criteria_Key: type: integer format: int32 nullable: true description: maxLength: 512 type: string nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 200 type: string description: User that first added the record to the system nullable: true reinsContract_Key: type: integer format: int32 nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsDomesticClaimCriteriaListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsDomesticClaimCriteria' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsDomesticClaimCriteriaVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsDomesticClaimCriteria' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsLevel: required: - reinsContract_Key - reinsLevel_Seq type: object properties: reinsContract_Key: type: integer description: 'References the ReinsContract.ReinsContract_Key on parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 reinsLevel_Seq: type: integer description: 'The unique sequence for this reinsurance level on this contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 benefit_Code: maxLength: 10 type: string description: The benefit code assigned to this reinsurance level. nullable: true deductible_Pct: type: number description: The reinsurance level deductible percent to be applied during transaction creation. format: double nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true reins_Level_From: type: number description: The reinsurance level range. format: double nullable: true reins_Level_Thru: type: number description: The reinsurance level range. format: double nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReinsLevelListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsLevel' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsLevelVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsLevel' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsServiceAddFromExisting: type: object properties: reinsContract_Key: type: integer format: int32 user_ID: type: string nullable: true description: type: string nullable: true contract_ID: type: string nullable: true effective_Date: type: string format: date-time nullable: true term_Date: type: string format: date-time nullable: true additionalProperties: false ReinsServiceAddFromTemplate: type: object properties: template_ReinsContract_Key: type: integer format: int32 user_ID: type: string nullable: true templateGroupConfigs: type: array items: $ref: '#/components/schemas/TemplateGroupConfig' nullable: true additionalProperties: false ReinsuranceOption: required: - reinsurance_Option type: object properties: reinsurance_Option: maxLength: 256 minLength: 1 type: string entry_Date: type: string format: date-time nullable: true entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: maxLength: 20 type: string nullable: true additionalProperties: false ReinsuranceOptionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReinsuranceOption' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReinsuranceOptionVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReinsuranceOption' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Relationships: required: - relate_Code type: object properties: relate_Code: maxLength: 8 minLength: 1 type: string description: Code that specifies the relationship of the Member to the Subscriber. description: maxLength: 32 type: string description: Describes the relationship of the Member to the Subscriber. nullable: true entry_Date: type: string description: Date when the record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true hipaA_Code: maxLength: 8 type: string description: HIPAA code that is related to the selected Relationship. nullable: true spouse: maxLength: 1 type: string description: Indicates that the selected relationship is associated with the Spouse. nullable: true subscriber: maxLength: 1 type: string description: Indicates that the selected relationship is associated with the Subscriber. nullable: true update_Date: type: string description: Date when the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false RelationshipsListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Relationships' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false RelationshipsVBAResponse: type: object properties: data: $ref: '#/components/schemas/Relationships' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportCategory: required: - report_Category type: object properties: report_Category: maxLength: 16 minLength: 1 type: string description: Name for the 'Report Category'. description: maxLength: 256 type: string description: Description of the 'Report Category'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportCategoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportCategory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportCategoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportCategory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportDefinition: required: - combine_Navigation - exclude_Adjustment_Category - exclude_Other_Category - exclude_Total_Category - group_Categories_Only - navigation_Report - report_Description - report_ID - report_Name - reportDefinition_Key - schedule_Report - series_Report - trackable_Report type: object properties: reportDefinition_Key: type: integer description: 'ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 bR_Report_ID: maxLength: 512 type: string description: Contains the GUID for the corresponding Advanced Reporting ID in Bold Reports. nullable: true combine_Navigation: type: boolean description: 'This will combine the results of a criteria window with multiple criteria. Note: This field is marked as NOT NULL in the database and therefore required by the API.' criteria_Object: maxLength: 128 type: string description: The PowerBuilder object used to enter criteria. nullable: true custom_Report: maxLength: 2048 type: string description: Identifies a custom report to be used. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true exclude_Adjustment_Category: type: boolean description: 'Flag indicating if the adjustment category should be excluded from the report Note: This field is marked as NOT NULL in the database and therefore required by the API.' exclude_Other_Category: type: boolean description: 'Flag indicating if the other category should be excluded from the report Note: This field is marked as NOT NULL in the database and therefore required by the API.' exclude_Total_Category: type: boolean description: 'Flag indicating if the total category should be excluded from the report Note: This field is marked as NOT NULL in the database and therefore required by the API.' group_Categories_Only: type: boolean description: 'Limits the report to only showing Rate Categories defined at the Group, not all Rate Categories on the Invoice. Note: This field is marked as NOT NULL in the database and therefore required by the API.' help_File: maxLength: 256 type: string description: Help file associated with the report object nullable: true help_Topic_ID: type: integer description: Topic ID within the help file associated with the report object format: int32 nullable: true invoice_Category_Column_Count: type: integer description: Identifies how many category columns are used within the report. format: int32 nullable: true navigation_Report: type: boolean description: 'Indicates that the report has navigation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' report_Category: maxLength: 16 type: string description: Identifies which category the report belongs to. nullable: true report_Description: maxLength: 512 minLength: 1 type: string description: Full description of the report. report_Detail_Object: maxLength: 128 type: string description: Specifies a secondary report that may be used in conjunction with the main report nullable: true report_Example: maxLength: 128 type: string description: Utilize the file explorer to choose an example of the chosen report. nullable: true report_ID: maxLength: 32 minLength: 1 type: string description: ID of the report being defined. report_Library: maxLength: 128 type: string description: Identifies which report library the User wishes to choose from. nullable: true report_Name: maxLength: 128 minLength: 1 type: string description: Name of the report. report_Object: maxLength: 128 type: string description: Indicates which report will be used with the automation step. nullable: true schedule_Report: type: boolean description: 'Indicates that the report may be used with scheduling functionality. Note: This field is marked as NOT NULL in the database and therefore required by the API.' series_Report: type: boolean description: 'Indicates that the report may be added to a report series. Note: This field is marked as NOT NULL in the database and therefore required by the API.' trackable_Report: type: boolean description: 'Indicates that tracking functionality will be used for the report. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportDefinitionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportDefinition' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportDefinitionVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportDefinition' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportQueue: required: - reportQueue_Key type: object properties: reportQueue_Key: type: integer description: 'ID of the report queue. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true queue_Date: type: string description: Date of the Queue. format: date-time nullable: true queue_End: type: string description: End of the Queue. format: date-time nullable: true queue_Printer: maxLength: 128 type: string description: Printer of the Queue. nullable: true queue_Priority: type: integer description: Priority of the Queue. format: int32 nullable: true queue_Start: type: string description: Start of the Queue. format: date-time nullable: true queue_Status: maxLength: 32 type: string description: Status of the Queue. nullable: true queue_Type: maxLength: 32 type: string description: Type of the Queue. nullable: true queue_User: maxLength: 20 type: string description: User of the Queue. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportQueueDetail: required: - reportQueue_Key - reportQueueDetail_Key type: object properties: reportQueueDetail_Key: type: integer description: 'ID of the report queue detail. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true queue_Export_File_Name: maxLength: 128 type: string description: File Name of the file to export. nullable: true queue_Export_Type: maxLength: 32 type: string description: Type of Export of the Queue. nullable: true queue_File: type: string description: Used to store a file used by the Queue. format: byte nullable: true queue_Result: maxLength: 32 type: string description: Result code used when Queue completes. nullable: true queue_Result_Date: type: string description: Date the Result was updated. format: date-time nullable: true queue_XML: type: string description: Used to store XML used by the Queue. nullable: true reportDefinition_Key: type: integer description: ID of the report definition. format: int32 nullable: true reportQueue_Key: type: integer description: 'ID of the report queue. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 report_Library: maxLength: 128 type: string description: Identifies which report library the User wishes to choose from. nullable: true report_Object: maxLength: 64 type: string description: Indicates which report will be used with the automation step. nullable: true report_Save_Location: maxLength: 256 type: string description: Utilize the file explorer to choose a location where the report will be saved. nullable: true report_Save_Type: maxLength: 32 type: string description: File type used to save. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true vbaGateway_Document_Category: maxLength: 32 type: string description: Identifies which category the document belongs to. nullable: true vbaGateway_Document_Field1: maxLength: 64 type: string description: Field1 of the VBAGateway_Document. nullable: true vbaGateway_Document_Field2: maxLength: 64 type: string description: Field2 of the VBAGateway_Document. nullable: true vbaGateway_Document_Field3: maxLength: 64 type: string description: Field3 of the VBAGateway_Document. nullable: true vbaGateway_Document_Field4: maxLength: 64 type: string description: Field4 of the VBAGateway_Document. nullable: true vbaGateway_Document_Field5: maxLength: 64 type: string description: Field5 of the VBAGateway_Document. nullable: true vbaGateway_Document_File: maxLength: 256 type: string description: File of the VBAGateway_Document. nullable: true vbaGateway_Document_Folder: maxLength: 256 type: string description: Folder of the VBAGateway_Document. nullable: true vbaGateway_Document_ID: maxLength: 64 type: string description: Name of the document. nullable: true vbaGateway_Document_Label: maxLength: 256 type: string description: Short description of the document. nullable: true vbaGateway_Document_Type: maxLength: 32 type: string description: Identifies the type associated with the document. nullable: true vbaGateway_Document_Value1: maxLength: 128 type: string description: Value1 of the VBAGateway_Document. nullable: true vbaGateway_Document_Value2: maxLength: 128 type: string description: Value2 of the VBAGateway_Document. nullable: true vbaGateway_Document_Value3: maxLength: 128 type: string description: Value3 of the VBAGateway_Document. nullable: true vbaGateway_Document_Value4: maxLength: 128 type: string description: Value4 of the VBAGateway_Document. nullable: true vbaGateway_Document_Value5: maxLength: 128 type: string description: Value5 of the VBAGateway_Document. nullable: true vbaGateway_UserID: type: string description: ID of the Gateway User who will receive the chosen document. format: uuid nullable: true additionalProperties: false ReportQueueDetailArg: required: - reportQueueDetail_Key - reportQueueDetailArg_Key type: object properties: reportQueueDetailArg_Key: type: integer description: 'ID of the report queue detail argument Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 argument_Name: maxLength: 256 type: string description: Name of the argument that will be used by the report series when it is run nullable: true argument_Type: maxLength: 32 type: string description: Type of the argument that will be used by the report series when it is run nullable: true argument_Value: maxLength: 512 type: string description: Value of the argument that will be used by the report series when it is run nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true reportQueueDetail_Key: type: integer description: 'ID of the report queue detail Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportQueueDetailArgListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportQueueDetailArg' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportQueueDetailArgVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportQueueDetailArg' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportQueueDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportQueueDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportQueueDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportQueueDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportQueueListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportQueue' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportQueueLog: required: - reportQueueDetail_Key - reportQueueLog_Key - sharedObject_ID type: object properties: reportQueueLog_Key: type: integer description: 'Key field identifying a specific report queue log entry Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true log_Action: maxLength: 256 type: string description: Identifier of the action that was performed for a report or for queue maintenance nullable: true log_Date: type: string description: Date of the action that was performed for a report or for queue maintenance format: date-time nullable: true log_Message: maxLength: 4000 type: string description: Message associated with the action that was performed for a report or for queue maintenance nullable: true log_Result: maxLength: 256 type: string description: Result of the action that was performed for a report or for queue maintenance nullable: true reportQueueDetail_Key: type: integer description: 'ID of the report queue detail Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 sharedObject_ID: type: integer description: 'Allows the logging of IDs for any shared objects for the report. Not normally used. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportQueueLogListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportQueueLog' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportQueueLogVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportQueueLog' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportQueueSchedule: required: - event_ID - reportQueue_Key - reportQueueSchedule_Key type: object properties: reportQueueSchedule_Key: type: integer description: 'Key field identifying a specific report queue schedule Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 email_Address: maxLength: 128 type: string description: Optional field for storing the associated email address nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true event_ID: type: integer description: 'ID of the report event that will be performed Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 reportQueue_Key: type: integer description: 'ID of the report queue. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 save_Location: maxLength: 256 type: string description: Optional field for storing the location where the report will be saved nullable: true schedule_Type: maxLength: 16 type: string description: Optional field for storing the type of report schedule nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportQueueScheduleListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportQueueSchedule' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportQueueScheduleVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportQueueSchedule' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportQueueVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportQueue' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeries: required: - reportSeries_Key type: object properties: reportSeries_Key: type: integer description: 'ID of the report series. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true series_Date: type: string description: Date when the automation will begin/began. format: date-time nullable: true series_Description: maxLength: 512 type: string description: Description of the report series. nullable: true series_Status: maxLength: 32 type: string description: Identifies the current status of the report series. nullable: true series_Type: maxLength: 32 type: string description: Identifies the automation type for the report series. nullable: true series_User: maxLength: 16 type: string description: User ID of the person either initiating or running the report series nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportSeriesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportSeries' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeriesProcess: required: - reportSeriesProcess_Key type: object properties: reportSeriesProcess_Key: type: integer description: 'ID of the report series process. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the report series process. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true note_Category: maxLength: 8 type: string description: Indicates which category notes for this report series will be assigned. nullable: true pA_Stored_Proc: maxLength: 256 type: string description: Name of the stored procedure that corresponds to the Report Series used in VBAReport. nullable: true trigger_Description: maxLength: 2056 type: string description: Description of how the report series will trigger. nullable: true trigger_Option: maxLength: 64 type: string description: This flag enables an option used by Process Automation. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportSeriesProcessArg: required: - argument_Name - reportSeriesProcess_Key type: object properties: reportSeriesProcess_Key: type: integer description: 'ID of the report series process to which the argument is related. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 argument_Name: maxLength: 256 minLength: 1 type: string description: Name for the report series process argument. argument_Description: maxLength: 1024 type: string description: Description of the report series process argument. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true note_Column: type: integer description: Optional field for storing any additional notes about the report series process argument format: int32 nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportSeriesProcessArgListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportSeriesProcessArg' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeriesProcessArgVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportSeriesProcessArg' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeriesProcessListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportSeriesProcess' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeriesProcessTemplate: required: - reportSeries_Key - reportSeriesProcess_Key - reportSeriesProcessTemplate_Key type: object properties: reportSeriesProcessTemplate_Key: type: integer description: 'ID of the report series process template. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true reportSeriesProcess_Key: type: integer description: 'ID of the report series process that the template is related to. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 reportSeries_Filter: type: string description: Identifies the filter that is being applied to the series templates. nullable: true reportSeries_Key: type: integer description: 'ID of the report series that the process template is related to. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportSeriesProcessTemplateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportSeriesProcessTemplate' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeriesProcessTemplateVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportSeriesProcessTemplate' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeriesProcessVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportSeriesProcess' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeriesStep: required: - friday - monday - reportSeries_Key - reportSeriesStep_Key - saturday - step_Seq - sunday - thursday - tuesday - wednesday type: object properties: reportSeriesStep_Key: type: integer description: 'ID of the report series step. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 eMail_Body: maxLength: 4000 type: string description: Body text of the email. nullable: true eMail_From: maxLength: 128 type: string description: Identifies the sender email. nullable: true eMail_Server: maxLength: 128 type: string description: Indicates the server over which the email will be sent. nullable: true eMail_Subject: maxLength: 256 type: string description: Subject line of the email. nullable: true eMail_To: maxLength: 128 type: string description: Indentifies the receiver email. nullable: true end_Date: type: string description: Indicates the date when the event will stop occurring. format: date-time nullable: true end_Option: type: integer description: Indicates how the event will end. format: int32 nullable: true end_Time: type: string description: Indicates at what time the event will cease to occur on the defined date(s). format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true event_Priority: maxLength: 32 type: string description: Indicates the priority of the event. nullable: true event_Processor: maxLength: 64 type: string description: PowerBuilder object used to process. nullable: true event_Subject: maxLength: 256 type: string description: Describes the subject of the event. nullable: true event_UserGroup_Key: type: integer description: Identifies the Group that will be notified by the event. format: int32 nullable: true event_User_ID: maxLength: 16 type: string description: Identifies the User who will be notified by the event. nullable: true frequency: type: integer description: Month the event occurs. format: int32 nullable: true frequency_Factor: type: integer description: Day the event occurs. format: int32 nullable: true friday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' interval_Option: type: integer description: 'Interval Options are Days, Weekdays, Day in Month, Relative Day in Month, Date, or date in Month.' format: int32 nullable: true monday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' note_Category: maxLength: 8 type: string description: Identifies which category that the note belongs to. nullable: true note_Data: maxLength: 4000 type: string description: Body text of the note. nullable: true note_Subject: maxLength: 64 type: string description: Subject line of the note. nullable: true relative_Frequency: type: integer description: Day of the week the event occurs. format: int32 nullable: true reportDefinition_Key: type: integer description: ID of the report definition utilized in this step. format: int32 nullable: true reportSeries_Key: type: integer description: 'ID of the report series to which the step belongs. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 report_Criteria_Object: maxLength: 64 type: string description: Object of the Report_Criteria. nullable: true report_Library: maxLength: 128 type: string description: Identifies which report library the User wishes to choose from. nullable: true report_Object: maxLength: 64 type: string description: Indicates which report will be used with the automation step. nullable: true report_Printer: maxLength: 128 type: string description: Indicates which method will be used to print the selected report. nullable: true report_Save_Location: maxLength: 256 type: string description: Folder the report is saved to. nullable: true retry: type: integer description: 'Retry of the Retry. Note: The database will apply a default value of `0` for this field if a value is not provided.' format: int32 nullable: true saturday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' schedule_Interval: type: integer description: Indicates how often the event will occur. The interval will determine which options are available for the event schedule. format: int32 nullable: true start_Date: type: string description: Indicates the date when the event will begin occurring by the defined recurrence options. format: date-time nullable: true start_Time: type: string description: Indicates at what time the event will occur on the defined date(s). format: date-time nullable: true step_Date: type: string description: Date when the step will occur. format: date-time nullable: true step_Delay: type: integer description: Identifies the number of the selected time period that the step will be delayed by. format: int32 nullable: true step_Delay_Type: maxLength: 32 type: string description: Identifies the time period that the step will be delayed by. nullable: true step_Description: maxLength: 512 type: string description: Description of the report series step. nullable: true step_Key: type: integer description: Field used to flag a record for processing by Process Automation. format: int32 nullable: true step_MetaData: maxLength: 512 type: string description: Generic column to store meta data. nullable: true step_Seq: type: integer description: 'Identifies the sequence number assigned to the step. This number dictates which order the report series steps will occur (ascending order). Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 step_Type: maxLength: 32 type: string description: Identifies the type associated with this step. nullable: true sunday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' thursday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' total_Occurrences: type: integer description: Number of occurrences that will take place before the event ends. format: int32 nullable: true tuesday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true vbaGateway_Document_Category: maxLength: 32 type: string description: Identifies which category the document belongs to. nullable: true vbaGateway_Document_Field1: maxLength: 64 type: string description: Field1 of the VBAGateway_Document. nullable: true vbaGateway_Document_Field2: maxLength: 64 type: string description: Field2 of the VBAGateway_Document. nullable: true vbaGateway_Document_Field3: maxLength: 64 type: string description: Field3 of the VBAGateway_Document. nullable: true vbaGateway_Document_Field4: maxLength: 64 type: string description: Field4 of the VBAGateway_Document. nullable: true vbaGateway_Document_Field5: maxLength: 64 type: string description: Field5 of the VBAGateway_Document. nullable: true vbaGateway_Document_File: maxLength: 256 type: string description: File of the VBAGateway_Document. nullable: true vbaGateway_Document_Folder: maxLength: 256 type: string description: Folder of the VBAGateway_Document. nullable: true vbaGateway_Document_ID: maxLength: 64 type: string description: Name of the document. nullable: true vbaGateway_Document_Label: maxLength: 256 type: string description: Short description of the document. nullable: true vbaGateway_Document_Type: maxLength: 32 type: string description: Identifies the type associated with the document. nullable: true vbaGateway_Document_Value1: maxLength: 128 type: string description: Value1 of the VBAGateway_Document. nullable: true vbaGateway_Document_Value2: maxLength: 128 type: string description: Value2 of the VBAGateway_Document. nullable: true vbaGateway_Document_Value3: maxLength: 128 type: string description: Value3 of the VBAGateway_Document. nullable: true vbaGateway_Document_Value4: maxLength: 128 type: string description: Value4 of the VBAGateway_Document. nullable: true vbaGateway_Document_Value5: maxLength: 128 type: string description: Value5 of the VBAGateway_Document. nullable: true vbaGateway_UserID: type: string description: ID of the Gateway User who will receive the chosen document. format: uuid nullable: true wednesday: type: boolean description: 'Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false ReportSeriesStepArg: required: - reportSeriesStep_Key - reportSeriesStepArg_Key type: object properties: reportSeriesStepArg_Key: type: integer description: 'ID of the report series step argument. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 argument_Name: maxLength: 256 type: string description: Name of the step argument. nullable: true argument_Type: maxLength: 32 type: string description: Identifies the type associated with the argument. nullable: true argument_Value: maxLength: 512 type: string description: The value of the argument. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true reportSeriesStep_Key: type: integer description: 'ID of the report series step that the argument is associated with. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportSeriesStepArgListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportSeriesStepArg' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeriesStepArgVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportSeriesStepArg' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeriesStepListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportSeriesStep' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeriesStepVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportSeriesStep' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeriesTrackingArg: required: - reportSeries_Key - reportSeriesProcess_Key - reportSeriesTrackingArg_Key type: object properties: reportSeriesTrackingArg_Key: type: integer description: 'ID of the report series tracking argument. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 argument_Name: maxLength: 256 type: string description: Name of the step argument. nullable: true argument_Type: maxLength: 32 type: string description: Identifies the type associated with the argument. nullable: true argument_Value: maxLength: 512 type: string description: The value of the argument. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true reportSeriesProcess_Key: type: integer description: 'ID of the report series process associated with the tracking argument. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 reportSeries_Key: type: integer description: 'ID of the report series that the tracking argument is associated with. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportSeriesTrackingArgListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportSeriesTrackingArg' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeriesTrackingArgVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportSeriesTrackingArg' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportSeriesVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportSeries' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportTrack: required: - reportQueueDetail_Key - reportTrack_Key type: object properties: reportTrack_Key: type: integer description: 'ID of the report tracking. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true priority: maxLength: 32 type: string description: Identifies the priority of the report. nullable: true received_Date: type: string description: Date when the report was received. format: date-time nullable: true received_Status: maxLength: 32 type: string description: Identifies the 'Receieved Status' of the report. nullable: true received_User: maxLength: 20 type: string description: ID of the User who received the report. nullable: true reportQueueDetail_Key: type: integer description: 'ID of the report queue detail. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.' format: int32 sent_Date: type: string description: Identifies the date when the report was sent. format: date-time nullable: true sent_Status: maxLength: 32 type: string description: Identifies the sent status of the report. nullable: true sent_To: maxLength: 32 type: string description: Identifies the 'Sent To' subject of the report. nullable: true sent_User: maxLength: 20 type: string description: ID of the User who sent the report. nullable: true tracking_Status: maxLength: 32 type: string description: Identifies the tracking status of the report. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportTrackListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportTrack' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportTrackPriority: required: - priority - priority_Default - reportDefinition_Key type: object properties: reportDefinition_Key: type: integer description: 'ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 priority: maxLength: 32 minLength: 1 type: string description: Name for the 'Report Priority'. description: maxLength: 128 type: string description: Description of the 'Report Priority'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true priority_Default: type: boolean description: 'Indicates that this priority will be chosen by default for new reports. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportTrackPriorityListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportTrackPriority' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportTrackPriorityVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportTrackPriority' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportTrackReceivedStatus: required: - received_Status - reportDefinition_Key - status_Default type: object properties: reportDefinition_Key: type: integer description: 'ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 received_Status: maxLength: 32 minLength: 1 type: string description: Name for the 'Received Status'. description: maxLength: 128 type: string description: Description of the 'Received Status'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true status_Default: type: boolean description: 'Indicates that this status will be chosen by default for new reports. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportTrackReceivedStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportTrackReceivedStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportTrackReceivedStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportTrackReceivedStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportTrackSentStatus: required: - reportDefinition_Key - sent_Status - status_Default type: object properties: reportDefinition_Key: type: integer description: 'ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 sent_Status: maxLength: 32 minLength: 1 type: string description: Name for the 'Sent Status'. description: maxLength: 128 type: string description: Description of the 'Sent Status'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true status_Default: type: boolean description: 'Indicates that this status will be chosen by default for new reports. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportTrackSentStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportTrackSentStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportTrackSentStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportTrackSentStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportTrackSentTo: required: - reportDefinition_Key - sent_To - sent_To_Default type: object properties: reportDefinition_Key: type: integer description: 'ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 sent_To: maxLength: 32 minLength: 1 type: string description: Name for the 'Sent To' subject. description: maxLength: 128 type: string description: Description of the 'Sent To' subject. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true sent_To_Default: type: boolean description: 'Indicates that this ''Sent To'' subject will be chosen by default for new reports. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportTrackSentToListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportTrackSentTo' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportTrackSentToVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportTrackSentTo' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportTrackStatus: required: - reportDefinition_Key - status_Default - tracking_Status type: object properties: reportDefinition_Key: type: integer description: 'ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 tracking_Status: maxLength: 32 minLength: 1 type: string description: Name for the 'Tracking Status'. description: maxLength: 128 type: string description: Description of the 'Tracking Status'. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true status_Default: type: boolean description: 'Indicates that this ''Tracking Status'' will be chosen by default for new reports. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReportTrackStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportTrackStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportTrackStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportTrackStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReportTrackVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReportTrack' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReviewedStatus: required: - reviewed_Status type: object properties: reviewed_Status: maxLength: 6 minLength: 1 type: string description: Identifier for the claim review status description: maxLength: 128 type: string description: Description for the claim review status nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ReviewedStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReviewedStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ReviewedStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/ReviewedStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SMSDTO: type: object properties: parentActivityId: type: string description: Activity ID that spawned this nullable: true when: type: string format: date-time nullable: true onSuccess: $ref: '#/components/schemas/CallbackDTO' onFailure: $ref: '#/components/schemas/CallbackDTO' senderClientId: type: string description: The 3 chatacter ID for the Client to bill for the message nullable: true toNumber: type: string description: The number to send the SMS nullable: true content: type: string description: The content of the SMS nullable: true additionalProperties: false SSOConfig: required: - ssO_Enable - ssoConfig_ID type: object properties: ssoConfig_ID: maxLength: 32 minLength: 1 type: string description: A unique identifier for each SSO configuration setting. This is the primary key of the table. auth_URL: maxLength: 512 type: string description: The authorization URL for the initial authentication step in the SSO process. nullable: true client_ID: maxLength: 256 type: string description: The client ID issued by the identity provider. nullable: true client_Secret: maxLength: 256 type: string description: The client secret issued by the identity provider. nullable: true description: type: string description: A detailed description of the SSO configuration. nullable: true display: maxLength: 64 type: string description: The display name for the SSO configuration. This value is displayed to the user on the login screen. nullable: true provider_Name: maxLength: 128 type: string description: 'The name of the SSO provider (e.g., Active Directory, Google, Okta, Auth0).' nullable: true redirect_URL: maxLength: 512 type: string description: The URL to which the identity provider will redirect the user after authentication. nullable: true ssO_Enable: type: boolean description: 'A flag indicating whether the SSO configuration is enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.' scopes: maxLength: 512 type: string description: A list of scopes or permissions requested from the identity provider. nullable: true token_URL: maxLength: 512 type: string description: The token URL used to exchange an authorization code for an access token. nullable: true additionalProperties: false SSOConfigListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SSOConfig' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SSOConfigVBAResponse: type: object properties: data: $ref: '#/components/schemas/SSOConfig' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SearchConfig: required: - description - functionalArea - id - tableConfigs type: object properties: id: maxLength: 32 minLength: 1 type: string description: Unique identifier for the SearchConfig. Use this value when creating a search Criteria. functionalArea: maxLength: 64 minLength: 1 type: string description: The FunctionalArea for which the SearchConfig belongs. description: maxLength: 512 minLength: 1 type: string description: Description of the SearchConfig tableConfigs: type: array items: $ref: '#/components/schemas/TableConfig' description: List of Tables and Columns that are accessible to this SearchConfig. additionalProperties: false SearchConfigListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SearchConfig' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SearchConfigVBAResponse: type: object properties: data: $ref: '#/components/schemas/SearchConfig' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SearchRequest: required: - criteria_Key - searchConfigId - selectedFields type: object properties: criteria_Key: type: integer description: The unique Criteria_Key that contains the search criteria that will be applied to a SearchConfig. format: int32 searchConfigId: minLength: 1 type: string description: The unique id of the SearchConfig for which the Criteria will be applied. user_ID: type: string description: Fields to return in the search results. These must be a subset of the SearchConfig Fields. nullable: true page: type: integer format: int32 nullable: true pageCount: type: integer format: int32 nullable: true include_Result_Details: type: boolean nullable: true use_Random_Sample: type: boolean description: 'This flag indicates you want your search to return a random sample or records matching your search criteria. If you flag this as true, Random_Sample_Count must also be a value >= 0 or it will throw an exception.' nullable: true random_Sample_Count: type: integer description: 'This value is the raw count of random records you want as a sample based on your search. Value must be between 0-1000 (because search has paging, this value will default limit to 750 if you do not pass in a larger page size). As noted below, this value must be between 0-100 if you are flagging this as a percent sample.' format: int32 nullable: true random_Sample_Count_Is_Percent: type: boolean description: 'This flag indicates that the value in Random_Sample_Count is a Percent value between 0-100. If true, the Random_Sample_Count is used as the Pct sample of the full result set. As noted, if this is true, the value in Random_Sample_Count must be between 0-100 or an exception will be thrown.' nullable: true use_Nth_Result: type: boolean description: This flag indicates you want your search to return a the Nth result of the results of the search. nullable: true nth_Result: type: integer description: 'This value is the Nth result you would like returned from the search results. Value must be >= 0 and less than the total number of results. If greater than the total number of results, it will return the last result.' format: int32 nullable: true criterias: type: array items: $ref: '#/components/schemas/CriteriaDetail' nullable: true selectedFields: type: array items: $ref: '#/components/schemas/SelectedField' additionalProperties: false SearchResult: required: - criteria_Key - fieldMapping - results - search_SQL_Statement - searchConfigId type: object properties: searchConfigId: minLength: 1 type: string description: Identifier for the search that was performed. criteria_Key: type: integer description: Identifier for the criteria used against this search. format: int32 search_SQL_Statement: minLength: 1 type: string description: SQL Statement used to generate the search results. fieldMapping: type: array items: $ref: '#/components/schemas/FieldMap' description: Headers that describe the results contained within the Rows. results: type: array items: type: array items: { } description: All of the rows returned in the search results. additionalProperties: false description: Search results from an executed Search Request. SearchResultVBAResponse: type: object properties: data: $ref: '#/components/schemas/SearchResult' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityArea: required: - security_Area type: object properties: security_Area: maxLength: 16 minLength: 1 type: string description: Name of the security area that the displayed security options will apply to. description: maxLength: 64 type: string description: Description of the security area. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false SecurityAreaListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityArea' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityAreaObject: required: - object_Name - security_Area type: object properties: security_Area: maxLength: 16 minLength: 1 type: string description: Name of the security area that the displayed security options will apply to. object_Name: maxLength: 128 minLength: 1 type: string description: 'Name of the object from the object list. The purpose of this list is to allow the Administrator to select which objects will be contained within the associated ‘Security Area’. The User may select objects from this list, right-click, and select ''Apply Selected'' from the context menu.' additionalProperties: false SecurityAreaObjectListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityAreaObject' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityAreaObjectVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityAreaObject' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityAreaOverride: required: - override_All - override_Exclude - securityAreaOverride_Key type: object properties: securityAreaOverride_Key: type: integer description: The ‘Overrides’ tab currently has no functionality. format: int32 override_All: type: boolean description: The ‘Overrides’ tab currently has no functionality. override_Exclude: type: boolean description: The ‘Overrides’ tab currently has no functionality. override_Field: maxLength: 64 type: string description: The ‘Overrides’ tab currently has no functionality. nullable: true override_Value: maxLength: 128 type: string description: The ‘Overrides’ tab currently has no functionality. Name of the Group that the Override will be applied to. nullable: true security_Area: maxLength: 16 type: string description: The ‘Overrides’ tab currently has no functionality. nullable: true additionalProperties: false SecurityAreaOverrideListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityAreaOverride' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityAreaOverrideVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityAreaOverride' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityAreaReport: required: - reportDefinition_Key - security_Area type: object properties: security_Area: maxLength: 16 minLength: 1 type: string description: Security area that the report is being applied to/removed from. reportDefinition_Key: type: integer description: 'Name of the report that is being applied or removed from the security area. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false SecurityAreaReportListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityAreaReport' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityAreaReportVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityAreaReport' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityAreaUser: required: - security_Area - user_ID type: object properties: user_ID: maxLength: 16 minLength: 1 type: string description: ID of the User whom the level is being set for. security_Area: maxLength: 16 minLength: 1 type: string description: Security area that the User settings are being configured for. entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true security_Level: type: integer description: Security level that is being applied to the selected User. format: int32 nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false SecurityAreaUserGroup: required: - security_Area - security_Level - userGroup_Key type: object properties: security_Area: maxLength: 16 minLength: 1 type: string description: Security area that the User Group settings are being configured for. userGroup_Key: type: integer description: ID of the User Group that the level is being set for. format: int32 security_Level: type: integer description: Security level that is being applied to the selected User. format: int32 additionalProperties: false SecurityAreaUserGroupListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityAreaUserGroup' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityAreaUserGroupVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityAreaUserGroup' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityAreaUserListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityAreaUser' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityAreaUserVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityAreaUser' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityAreaVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityArea' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityField: required: - securityField_ID type: object properties: securityField_ID: maxLength: 32 minLength: 1 type: string description: Unique identifier for the Security Field entry. column_Name: maxLength: 256 type: string description: 'Name of the Column, without table, containing values for the Security Field entry.' nullable: true display: maxLength: 64 type: string description: This is what the user sees on the front-end for this field entry. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true table_Name: maxLength: 256 type: string description: Name of Table containing values for the Security Field entry. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false SecurityFieldListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityField' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityFieldSet: required: - securityFieldSet_ID type: object properties: securityFieldSet_ID: maxLength: 32 minLength: 1 type: string description: Unique identifier for the Security Field Set entry. description: maxLength: 512 type: string description: Description of the Security Field Set. nullable: true display: maxLength: 64 type: string description: Display name of the Security Field Set. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false SecurityFieldSetDetail: required: - securityField_ID - securityFieldSet_ID type: object properties: securityFieldSet_ID: maxLength: 32 minLength: 1 type: string description: Unique identifier for the Security Field Set entry. securityField_ID: maxLength: 32 minLength: 1 type: string description: Unique identifier for the Security Field entry. entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true field_Access: maxLength: 16 type: string description: 'Type of Field access that is applied. Only two values: VIEW or VIEW_MASK. VIEW locks the field down but shows the information in the field. VIEW_MASK allow the field to be viewed only but also the information is masked.' nullable: true field_Mask: maxLength: 512 type: string description: 'Identifies the type of Mask applied to this feild. For now, only two values apply: SSN or ALL. SSN applies a standard mask of xxx-xx-9977 vs a mask of ALL which sets the field to ***** regardless of value being stored.' nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false SecurityFieldSetDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityFieldSetDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityFieldSetDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityFieldSetDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityFieldSetListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityFieldSet' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityFieldSetVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityFieldSet' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityFieldUser: required: - securityFieldUser_Key - user_ID type: object properties: securityFieldUser_Key: type: integer description: 'Unique identifier for the Security Field User entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true field_Access: maxLength: 16 type: string description: 'Type of Field access that is applied. Only two values: VIEW or VIEW_MASK. VIEW locks the field down but shows the information in the field. VIEW_MASK allow the field to be viewed only but also the information is masked.' nullable: true field_Mask: maxLength: 512 type: string description: 'Identifies the type of Mask applied to this feild. For now, only two values apply: SSN or ALL. SSN applies a standard mask of xxx-xx-9977 vs a mask of ALL which sets the field to ***** regardless of value being stored.' nullable: true securityFieldSet_ID: maxLength: 32 type: string description: Unique identifier for the Security Field Set entry. nullable: true securityField_ID: maxLength: 32 type: string description: Unique identifier for the Security Field entry. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true user_ID: maxLength: 16 minLength: 1 type: string description: ID of the User whom the level is being set for. additionalProperties: false SecurityFieldUserGroup: required: - securityFieldUserGroup_Key - userGroup_Key type: object properties: securityFieldUserGroup_Key: type: integer description: 'Unique identifier for the Security Field User Group entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true field_Access: maxLength: 16 type: string description: 'Type of Field access that is applied. Only two values: VIEW or VIEW_MASK. VIEW locks the field down but shows the information in the field. VIEW_MASK allow the field to be viewed only but also the information is masked.' nullable: true field_Mask: maxLength: 512 type: string description: 'Identifies the type of Mask applied to this feild. For now, only two values apply: SSN or ALL. SSN applies a standard mask of xxx-xx-9977 vs a mask of ALL which sets the field to ***** regardless of value being stored.' nullable: true securityFieldSet_ID: maxLength: 32 type: string description: Unique identifier for the Security Field Set entry. nullable: true securityField_ID: maxLength: 32 type: string description: Unique identifier for the Security Field entry. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true userGroup_Key: type: integer description: 'ID of the User Group that the level is being set for. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 additionalProperties: false SecurityFieldUserGroupListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityFieldUserGroup' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityFieldUserGroupVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityFieldUserGroup' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityFieldUserListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityFieldUser' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityFieldUserVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityFieldUser' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityFieldVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityField' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityGroupDivisionUser: required: - excluded - group_ID - securityGroupDivisionUser_Key - user_ID type: object properties: securityGroupDivisionUser_Key: type: integer description: Key of the SecurityGroupDivisionUser record format: int32 division_ID: maxLength: 20 type: string description: No longer in use nullable: true excluded: type: boolean description: Selecting this option means that the User will have access to every group EXCEPT the selected Group. group_ID: maxLength: 20 minLength: 1 type: string description: Identifier of the Group that the restriction is being configured for. user_ID: maxLength: 16 minLength: 1 type: string description: ID of the User whom the restriction is being configured for. additionalProperties: false SecurityGroupDivisionUserGroup: required: - group_ID - securityGroupDivisionUserGroup_Key - userGroup_Key type: object properties: securityGroupDivisionUserGroup_Key: type: integer description: No longer in use format: int32 division_ID: maxLength: 20 type: string description: No longer in use nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: No longer in use userGroup_Key: type: integer description: No longer in use format: int32 additionalProperties: false SecurityGroupDivisionUserGroupListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityGroupDivisionUserGroup' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityGroupDivisionUserGroupVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityGroupDivisionUserGroup' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityGroupDivisionUserListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityGroupDivisionUser' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityGroupDivisionUserVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityGroupDivisionUser' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityLevel: required: - description - security_Level type: object properties: security_Level: type: integer description: Identifies the level of security. Higher values indicate higher levels of access. format: int32 description: maxLength: 64 minLength: 1 type: string description: Description of the security level. additionalProperties: false SecurityLevelListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityLevel' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityLevelVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityLevel' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityUserLimitMemberClaimData: required: - securityUserLimitMemberClaimData_Key type: object properties: securityUserLimitMemberClaimData_Key: type: integer description: Key of the Security User Limit Member Data Limit format: int32 member_Seq: maxLength: 2 type: string description: Sequential identifier of the Member whose data is being limited. nullable: true subscriber_ID: maxLength: 9 type: string description: ID of the Subscriber whose data is being limited. This limit means that the User will be unable to see claim specifics (procedure codes and diagnosis codes) of the selected Member. nullable: true user_ID: maxLength: 16 type: string description: ID of the User to whom the Member Data limit is being applied. nullable: true additionalProperties: false SecurityUserLimitMemberClaimDataListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityUserLimitMemberClaimData' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityUserLimitMemberClaimDataVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityUserLimitMemberClaimData' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityUserRestriction: required: - restriction_All - restriction_Exclude - securityUserRestriction_Key type: object properties: securityUserRestriction_Key: type: integer description: User Retriction Key format: int32 restriction_All: type: boolean description: No Longer in use restriction_Exclude: type: boolean description: Selecting this option means that the User will have access to every subject of the same type EXCEPT the selected subject. restriction_Field: maxLength: 64 type: string description: Identifies the subject of the associated restriction. nullable: true restriction_Value: maxLength: 128 type: string description: Subject that the restriction is being determined for. The User will ONLY have access to the selected subject - unless the ‘Exclude’ option is selected. nullable: true user_ID: maxLength: 20 type: string description: ID of the User to whom the restrictions will be applied. nullable: true additionalProperties: false SecurityUserRestrictionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SecurityUserRestriction' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SecurityUserRestrictionVBAResponse: type: object properties: data: $ref: '#/components/schemas/SecurityUserRestriction' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SelectedField: required: - columnName - tableName type: object properties: tableName: minLength: 1 type: string description: Name of the table containing the column. columnName: minLength: 1 type: string description: Name of the column. additionalProperties: false SendTo: required: - disability - life - mail_To - medical - pay_To - sendTo_ID type: object properties: sendTo_ID: maxLength: 1 minLength: 1 type: string description: Identifier for a type of entity that will be used for sending payments and correspondence disability: type: boolean description: 'Flag indicating this entity can receive disability payments or correspondence Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true life: type: boolean description: 'Flag indicating this entity can receive life payments or correspondence Note: This field is marked as NOT NULL in the database and therefore required by the API.' mail_To: type: boolean description: 'Flag indicating correspondence can be sent to this entity Note: This field is marked as NOT NULL in the database and therefore required by the API.' medical: type: boolean description: 'Flag indicating this entity can receive medical payments or correspondence Note: This field is marked as NOT NULL in the database and therefore required by the API.' pay_To: type: boolean description: 'Flag indicating payments can be sent to this entity Note: This field is marked as NOT NULL in the database and therefore required by the API.' sendTo_Description: maxLength: 64 type: string description: Description of a type of entity that will be used for sending payments and correspondence nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false SendToListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SendTo' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SendToVBAResponse: type: object properties: data: $ref: '#/components/schemas/SendTo' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Signature: required: - signature_File - signature_Key type: object properties: signature_Key: type: integer description: 'Key value identifying a signature used on checks Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 64 type: string description: Description of the signature used on checks nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true signature_Code: maxLength: 32 type: string description: No longer used nullable: true signature_File: maxLength: 255 minLength: 1 type: string description: Location and name of the file that contains the signature update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false SignatureListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Signature' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SignatureVBAResponse: type: object properties: data: $ref: '#/components/schemas/Signature' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Specialty: required: - pcp - specialist - specialty_Code type: object properties: specialty_Code: maxLength: 10 minLength: 1 type: string all_Specialties: maxLength: 1 type: string nullable: true description: maxLength: 64 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true pcp: type: boolean specialist: type: boolean update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false SpecialtyCriteria: type: object properties: specialty_Code: type: string nullable: true sequence: type: integer format: int32 nullable: true age_From: type: integer format: int32 nullable: true age_Thru: type: integer format: int32 nullable: true sex: type: string nullable: true additionalProperties: false SpecialtyListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Specialty' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SpecialtyVBAResponse: type: object properties: data: $ref: '#/components/schemas/Specialty' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false State: required: - apply_State_Tax - calc_Interest_ACH_Business_Days - calc_Interest_Business_Days - default_Percentage_Election - state_Abbrev - use_Percentage_Election - use_StateInterest_Settings type: object properties: state_Abbrev: maxLength: 2 minLength: 1 type: string description: Two letter abbeviation for the state all_States: maxLength: 1 type: string description: Flag indicating the identifier refers to all states nullable: true apply_State_Tax: type: boolean description: 'Flag indicating if state tax should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.' calc_Interest_ACH_Business_Days: type: boolean description: 'Flag indicating if ACH/EDI prompt pay frequency is based on business days Note: This field is marked as NOT NULL in the database and therefore required by the API.' calc_Interest_ACH_Prompt_Pay_Freq: type: integer description: Number of units used for ACH/EDI prompt pay frequency format: int32 nullable: true calc_Interest_ACH_Prompt_Pay_Type: maxLength: 1 type: string description: 'Units used for ACH/EDI prompt pay frequency, either days, months or years' nullable: true calc_Interest_Business_Days: type: boolean description: 'Flag indicating if manual prompt pay frequency is based on business days Note: This field is marked as NOT NULL in the database and therefore required by the API.' calc_Interest_Prompt_Pay_Freq: type: integer description: Number of units used for manual prompt pay frequency format: int32 nullable: true calc_Interest_Prompt_Pay_Type: maxLength: 1 type: string description: 'Units used for manual prompt pay frequency, either days, months or years' nullable: true default_Percentage_Election: type: number description: 'Amount of the default percentage election that should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true state_Name: maxLength: 25 type: string description: Full name of the state nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true use_Percentage_Election: type: boolean description: 'Flag indicating if the default percentage election should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.' use_StateInterest_Settings: type: boolean description: 'Flag to control whether to use the State Interest entries for a specific state instead of State Details. Note: This field is marked as NOT NULL in the database and therefore required by the API.' additionalProperties: false StateInterest: required: - calc_Interest_ACH_Business_Days - calc_Interest_Business_Days - compound_ACH_Interest - compound_Interest - state - stateInterest_Key type: object properties: stateInterest_Key: type: integer description: 'Kev value identifying a specific state interest rate Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 acH_Interest_Pct: type: number description: 'Value for interest to five decimal places, used in EDI/ACH interest calculations.' format: double nullable: true acH_No_Interest_Within: maxLength: 20 type: string description: User selection to control a window for interest to be avoided in EDI/ACH calculations. nullable: true calc_Interest_ACH_Business_Days: type: boolean description: 'Flag to control force only business days on the calendar to be used in EDI/ACH interest calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.' calc_Interest_ACH_Prompt_Pay_Freq: type: integer description: Value for the (lower bound on StateInterest entries only) for Prompt Pay range in EDI/ACH calculations. format: int32 nullable: true calc_Interest_ACH_Prompt_Pay_Freq_Thru: type: integer description: Value for the upper bound (StateInterest entries only) for Prompt Pay range in EDI/ACH calculations. format: int32 nullable: true calc_Interest_ACH_Prompt_Pay_Type: maxLength: 1 type: string description: 'Defines the unit for the prompt pay range in EDI/ACH calculations. D = Days, M = Months, Y = Years.' nullable: true calc_Interest_Business_Days: type: boolean description: 'Flag to control force only business days on the calendar to be used in Manual/Default interest calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.' calc_Interest_Prompt_Pay_Freq: type: integer description: Value for the (lower bound on StateInterest entries only) for Prompt Pay range in Manual/Default calculations. format: int32 nullable: true calc_Interest_Prompt_Pay_Freq_Thru: type: integer description: Value for the upper bound (StateInterest entries only) for Prompt Pay range in Manual/Default calculations. format: int32 nullable: true calc_Interest_Prompt_Pay_Type: maxLength: 1 type: string description: 'Defines the unit for the prompt pay range in Manual/Default calculations. D = Days, M = Months, Y = Years.' nullable: true compound_ACH_Interest: type: boolean description: 'Flag to control if/how interest is compounded in EDI/ACH interest calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.' compound_Interest: type: boolean description: 'Flag to control if/how interest is compounded in Manual/Default interest calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.' effective_Date: type: string description: Date the interest rate becomes effective format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true interest_Pct: type: number description: Interest rate that applies in the specified state format: double nullable: true no_Interest_Within: maxLength: 20 type: string description: Option to indicate no interest should be applied within the selected timeframe nullable: true state: maxLength: 2 minLength: 1 type: string description: Two letter abbeviation for the state term_Date: type: string description: Date the interest rate terminates format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false StateInterestListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/StateInterest' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false StateInterestVBAResponse: type: object properties: data: $ref: '#/components/schemas/StateInterest' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false StateListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/State' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false StateProcedureCodeTax: required: - apply_State_Tax - belowLimitFlag - default_Percentage_Election - nonTaxableLimit - procedure_Code - state - use_Percentage_Election type: object properties: state: maxLength: 2 minLength: 1 type: string procedure_Code: maxLength: 8 minLength: 1 type: string apply_State_Tax: type: boolean belowLimitFlag: type: boolean default_Percentage_Election: type: number format: double entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true nonTaxableLimit: type: number format: double update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true use_Percentage_Election: type: boolean additionalProperties: false StateProcedureCodeTaxListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/StateProcedureCodeTax' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false StateProcedureCodeTaxVBAResponse: type: object properties: data: $ref: '#/components/schemas/StateProcedureCodeTax' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false StateVBAResponse: type: object properties: data: $ref: '#/components/schemas/State' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false StringListVBAResponse: type: object properties: data: type: array items: type: string nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false StringStaticOption: type: object properties: option_Key: type: string nullable: true display: type: string nullable: true description: type: string nullable: true additionalProperties: false StringStaticOptionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/StringStaticOption' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false StringStaticOptionVBAResponse: type: object properties: data: $ref: '#/components/schemas/StringStaticOption' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false StringVBAResponse: type: object properties: data: type: string nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubEnrollment: required: - division_ID - group_Coverage_Start - group_ID - start_Date - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Subscribers.Subscriber_ID value on the parent record. group_ID: maxLength: 20 minLength: 1 type: string description: References the GroupContract.Group_ID value in the parent table. division_ID: maxLength: 20 minLength: 1 type: string description: References the GroupContract.Division_ID value in the parent table. group_Coverage_Start: type: string description: References the GroupContract.Coverage_Start value in the parent table. format: date-time start_Date: type: string description: Start date of Subenrollment coverage. format: date-time annual_Max: type: number description: 'Annual maximum for identified policy. [Informational Only]' format: double nullable: true date_Employed: type: string description: Start date of the Subscriber's employment. format: date-time nullable: true eligibility_Date: type: string description: Date the Subscriber was eligible for coverage. format: date-time nullable: true end_Date: type: string description: End date of Subenrollment coverage. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 50 type: string description: User that first added the record to the system. nullable: true lifetime_Max: type: number description: 'Lifetime maximum for indentified policy. [Informational Only]' format: double nullable: true original_Enrollment_Date: type: string description: Identifies the date the Enrollment began. This is useful if a new Group is added and insured Members have been covered under the Group Plan earlier than their start date with you. format: date-time nullable: true paid_Through: type: string description: Date that the premiums have been paid through. This field will auto populate with the most recent closed invoice ‘Bill Thru’ date if 'Set Paid Thru' is set through the Control Panel. The 'Paid Thru Exceeded' Ex Code will be applied to Claims adjudicated with a service date beyond this date. format: date-time nullable: true policy_Number: maxLength: 25 type: string description: 'Policy number issued from Insurer. [Informational Only]' nullable: true term_Date: type: string description: Termination date of the Subscriber's employment. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 50 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false SubEnrollmentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubEnrollment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubEnrollmentPlan: required: - division_ID - group_Coverage_Start - group_ID - plan_ID - plan_Start - start_Date - subscriber_ID - use_Volume_Scale type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References the Subenrollment.Subscriber_ID value in the parent table. group_ID: maxLength: 20 minLength: 1 type: string description: References the Subenrollment.Group_ID value in the parent table. division_ID: maxLength: 20 minLength: 1 type: string description: References the Subenrollment.Division_ID value in the parent table. group_Coverage_Start: type: string description: 'References the Subenrollment.Group_Coverage_Start value in the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time start_Date: type: string description: 'References the Subenrollment.Start_Date value in the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time plan_ID: maxLength: 20 minLength: 1 type: string description: References the GroupContractPlan.Plan_ID value indicating which Plan this member is enrolling that is being offered. plan_Start: type: string description: 'Start date of Plan coverage. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time application_Received_Date: type: string description: Holds the date for the subscriber's application to disclose pre-existing conditions. format: date-time nullable: true dollar_Amount: type: number description: The Subscriber's 'Volume' within the selected plan on the enrollment. This will impact invoicing. format: double nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true ltC_Daily_Benefit_Amount: type: number description: Member elected Daily Benefit Amount format: double nullable: true ltC_Lifetime_Max_Amount: type: number description: Lifetime Max Amount elected format: double nullable: true ltC_Lifetime_Max_Days: type: integer description: Lifetime Max Days elected format: int32 nullable: true ltC_Lifetime_Max_Years: type: integer description: Lifetime Max Years elected format: int32 nullable: true ltC_Monthly_Benefit_Amount: type: number description: Member elected Monthly Benefit Amount format: double nullable: true paid_Through: type: string description: Date that the premiums have been paid through for this plan. The 'Paid Thru Exceeded' Ex Code will be applied to Claims adjudicated with a service date beyond this date. format: date-time nullable: true plan_End: type: string description: End date of Plan coverage. format: date-time nullable: true reason_ID: type: integer description: This identifier the reason the plan was termed. format: int32 nullable: true tier: maxLength: 2 type: string description: The Subscriber's 'Tier' within the selected plan on the enrollment. This will impact adjudication and invoicing. nullable: true update_Date: type: string description: Date when the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true use_Volume_Scale: type: boolean description: 'This option tells the system to calculate the ''Volume'' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.' writing_CommissionAgencyRep_Key: type: integer description: Unique identifier for the CommissionAgencyRep table format: int32 nullable: true additionalProperties: false SubEnrollmentPlanListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubEnrollmentPlan' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubEnrollmentPlanVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubEnrollmentPlan' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubEnrollmentRider: required: - benefit_Code - division_ID - employee_Contribution_Pct - from_Date - group_Coverage_Start - group_ID - initial_Volume_Salary_Pct - plan_ID - plan_Start - start_Date - subscriber_ID - use_Employee_Age - use_GI_Volume_Min_Max - use_Volume_Scale type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References the SubenrollmentPlan.Subscriber_ID value in the parent table. group_ID: maxLength: 20 minLength: 1 type: string description: References the SubenrollmentPlan.Group_ID value in the parent table. division_ID: maxLength: 20 minLength: 1 type: string description: References the SubenrollmentPlan.Division_ID value in the parent table. group_Coverage_Start: type: string description: References the SubenrollmentPlan.Group_Coverage_Start value in the parent table. format: date-time start_Date: type: string description: References the SubenrollmentPlan.Start_Date value in the parent table. format: date-time plan_ID: maxLength: 20 minLength: 1 type: string description: References the SubenrollmentPlan.Plan_ID value in the parent table. plan_Start: type: string description: References the SubenrollmentPlan.Plan_Start value in the parent table. format: date-time benefit_Code: maxLength: 10 minLength: 1 type: string description: References the BenefitCodes.Benefit_Code value that is flagged as a Rider on this Plan and indicates the optional coverage this member has enrolled in. from_Date: type: string description: Start date of Rider coverage. format: date-time billing_Member_Seq_Override: maxLength: 2 type: string description: 'By default, billing calculations use the insured demographic information for determing the settings. This value allows another member of the family to be used when determining those calculations.' nullable: true employee_Contribution: type: number description: Indicates the Employee Contribution amount that is used during Diability processing to properly take tax amounts. format: double nullable: true employee_Contribution_Pct: type: boolean description: 'Indicates if the Emploee Contribution amount entered is a Pct or flat amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true external_ID: maxLength: 64 type: string description: Custom value used for Ceridican tax processing interface. nullable: true initial_Volume: type: number description: This is the volume used in intial volume calculations. This number can either be a flat amount or a percentage of the Member's gross salary. format: double nullable: true initial_Volume_Salary_Pct: type: boolean description: 'Indicates that the number from the ''Initial Volume'' field represents a percentage of the Member''s salary. Salaries are found from a Member''s ''Financial'' detail dropdown. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' ltC_Daily_Benefit_Amount: type: number description: Member elected Daily Benefit Amount format: double nullable: true ltC_Lifetime_Max_Amount: type: number description: Lifetime Max Amount elected format: double nullable: true ltC_Lifetime_Max_Days: type: integer description: Lifetime Max Days elected format: int32 nullable: true ltC_Lifetime_Max_Years: type: integer description: Lifetime Max Years elected format: int32 nullable: true ltC_Monthly_Benefit_Amount: type: number description: Member elected Monthly Benefit Amount format: double nullable: true new_CommissionAgencyRep_Key: type: integer description: No longer in use. format: int32 nullable: true original_CommissionAgencyRep_Key: type: integer description: No longer in use. format: int32 nullable: true thru_Date: type: string description: End date of Rider coverage. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true use_Employee_Age: type: boolean description: 'Billing setting indicating that the employee age is used in all calculations that are age based for this specific Rider. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' use_GI_Volume_Min_Max: type: boolean description: 'The ''Gaurantee Issue'' option is an alternative to the ''Use Scale'' option. It offers a convenient secondary option for min/max when calculating Rider volume. Plan type must include the "Life AD&D" indicator. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' use_Volume_Scale: type: boolean description: 'This option tells the system to calculate the ''Volume'' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation. Plan type must include the "Life AD&D" indicator. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.' volume: type: number description: The Member's 'Volume' within the selected Rider benefit on the enrollment. The Member Enrollment 'Volume' has no impact on invoicing. format: double nullable: true additionalProperties: false SubEnrollmentRiderListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubEnrollmentRider' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubEnrollmentRiderVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubEnrollmentRider' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubEnrollmentVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubEnrollment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubPaymentMethod: required: - effective_Date - payment_Method - sub_Payment_Method_Key - subscriber_ID type: object properties: sub_Payment_Method_Key: type: integer description: 'The primary key and identifier of the record Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 acH_Pull_Day: type: integer description: Day of the month the ACH payment will be taken from the account format: int32 nullable: true benefit_Code: maxLength: 10 type: string description: References the benefit code associated with the payment method nullable: true effective_Date: type: string description: 'The effective date of the payment method Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true payment_Method: maxLength: 20 minLength: 1 type: string description: 'The payment method associated with the subscriber, plan, benefit code combination' plan_ID: maxLength: 20 type: string description: References the plan associated with the payment method nullable: true subscriber_ID: maxLength: 9 minLength: 1 type: string description: References the subscriber associated with the payment method term_Date: type: string description: The termination date of the payment method format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false SubPaymentMethodListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubPaymentMethod' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubPaymentMethodVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubPaymentMethod' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubmitMFACodeRequest: required: - mfaCode - session - username type: object properties: username: minLength: 1 type: string description: The username of the user sending the multi-factor authentication code. mfaCode: minLength: 1 type: string description: The multi-factor authentication code provided by the user. session: minLength: 1 type: string description: The session that should be passed both ways in challenge-response calls to the service. additionalProperties: false SubscriberAccum: required: - allowed_Amt - allowed_Amt_Net - allowed_Amt_OON - benefit_Code - benefit_Used - benefit_Used_Net - benefit_Used_OON - billed_Amt - billed_Amt_Net - billed_Amt_OON - coB_Amt - coB_Amt_Net - coB_Amt_OON - coins_Amt - coins_Amt_Net - coins_Amt_OON - copay_Amt - copay_Amt_Net - copay_Amt_OON - ded_Credit_OON_Used - ded_Credit_PPO_Used - ded_Credit_Used - ded_PPO_Used - deductible_Used - deductible_Used_OON - group_ID - not_Covered_Amt - not_Covered_Amt_Net - not_Covered_OON - out_Of_Pocket - out_Of_Pocket_Net - out_Of_Pocket_OON - plan_Type - plan_Year - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Subscribers.Subscriber_ID value on the parent record. group_ID: maxLength: 20 minLength: 1 type: string description: Identifier assigned to the Group associated with this Prior Accumulator. plan_Year: maxLength: 8 minLength: 1 type: string description: Plan Year associated with this Subscriber Accumulator. plan_Type: maxLength: 6 minLength: 1 type: string description: Plan Type associated with this Subscriber Accumulator. benefit_Code: maxLength: 10 minLength: 1 type: string description: Benefit Code associated with this Subscriber Accumulator. added_Accum: maxLength: 1 type: string description: Identifies that this Accumulator is an Added Accumulator. nullable: true allowed_Amt: type: number description: 'Total Allowed amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double allowed_Amt_Net: type: number description: 'Allowed amount that has been used In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double allowed_Amt_OON: type: number description: 'Allowed amount that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double benefit_Used: type: number description: 'Total amount of benefit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double benefit_Used_Net: type: number description: 'Net amount of benefit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double benefit_Used_OON: type: number description: 'Amount of benefit that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double billed_Amt: type: number description: 'Amount that has been billed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double billed_Amt_Net: type: number description: 'Amount that has been billed In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double billed_Amt_OON: type: number description: 'Amount that has been billed Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coB_Amt: type: number description: 'Total Coordination of Benefits amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coB_Amt_Net: type: number description: 'Net Coordination of Benefits amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coB_Amt_OON: type: number description: 'Coordination of Benefits amount that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coins_Amt: type: number description: 'Total amount of Coinsurance that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coins_Amt_Net: type: number description: 'Net amount of Coinsurance that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double coins_Amt_OON: type: number description: 'Amount of Coinsurance that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double copay_Amt: type: number description: 'Total amount of Copay that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double copay_Amt_Net: type: number description: 'Net amount of Copay that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double copay_Amt_OON: type: number description: 'Amount of Copay that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double ded_Credit_OON_Used: type: number description: 'Amount of deductible credit that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double ded_Credit_PPO_Used: type: number description: 'Net amount of deductible credit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double ded_Credit_Used: type: number description: 'Total amount of deductible credit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double ded_PPO_Used: type: number description: 'Net amount of deductible that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double deductible_Used: type: number description: 'Total amount of deductible that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double deductible_Used_OON: type: number description: 'Amount of deductible that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true not_Covered_Amt: type: number description: 'Total amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double not_Covered_Amt_Net: type: number description: 'Net amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double not_Covered_OON: type: number description: 'Out of Network amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double out_Of_Pocket: type: number description: 'Total Out of Pocket amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double out_Of_Pocket_Net: type: number description: 'Amount of Out of Pocket that has been used In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double out_Of_Pocket_OON: type: number description: 'Amount of Out of Pocket that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false SubscriberAccumListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberAccum' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberAccumVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberAccum' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberFlex: required: - auto_Create_Flex - calendar_Year - custom_Election_Info_Only - effective_Date - full_Election_For_Partial_Year - group_ID - plan_ID - subscriber_ID - term_Date type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Subscribers.Subscriber_ID value on the parent record. group_ID: maxLength: 20 minLength: 1 type: string description: Identifier assigned to the Group associated with this Flex account. This is automatically populated by right-clicking inside of the field and selecting 'Lookup' from the context menu. plan_ID: maxLength: 20 minLength: 1 type: string description: Unique identifier assigned to the plan. This is automatically populated by right-clicking inside of the field and selecting 'Lookup' from the context menu. calendar_Year: maxLength: 4 minLength: 1 type: string description: Calendar year that is associated with the flex account. This is automatically populated by right-clicking inside of the field and selecting 'Lookup' from the context menu. effective_Date: type: string description: 'Date when the selected Flex account becomes/became active. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time auto_Create_Flex: type: boolean description: 'Indicates if this configuration would like to have flex claims auto created as part of the claims processing based on configured member responsibility amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.' cobrA_Rate: type: number description: Identifies the COBRA rate of the Flex account. format: double nullable: true card_Status: maxLength: 32 type: string description: Identifies the status of the Member's Flex account card. nullable: true custom_Election_Info_Only: type: boolean description: 'Identifies that the Flex account information is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.' election: type: number description: Specifies the Member's election amount toward the Flex account. format: double nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true full_Election_For_Partial_Year: type: boolean description: 'Identifies if the amount enetered in to the Election field is a full or partial year election amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' gross_Salary: type: number description: Specifies the Member's gross salary for the year associated with the Flex account. format: double nullable: true net_Salary: type: number description: Specifies the Member's net salary for the year associated with the Flex account. format: double nullable: true purse_Status: maxLength: 32 type: string description: References FlexVendorPurseStatus.Purse_Status for code list. nullable: true term_Date: type: string description: 'Date when the selected Flex account expires/expired. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false SubscriberFlexExported: required: - calendar_Year - effective_Date - group_ID - plan_ID - subscriber_ID - subscriberFlexExported_Key type: object properties: subscriberFlexExported_Key: type: integer description: 'Unique identifier for each exported record being tracked as part of Flex integrations. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 calendar_Year: maxLength: 4 minLength: 1 type: string description: References SubscriberFlex.Calendar_Year value on the parent record. effective_Date: type: string description: 'Date when the associated flex account becomes/became active. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true export_Amount: type: number description: The flex transaction amount sent for the associated integration. format: double nullable: true export_Date: type: string description: Indicates the date that this record was exported for the identified type. format: date-time nullable: true export_Status: maxLength: 32 type: string description: Custom value assigned by developer for the associated integration. nullable: true export_Type: maxLength: 32 type: string description: Custom value assigned by developer for the associated integration. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: References SubscriberFlex.Group_ID value on the parent record. plan_ID: maxLength: 20 minLength: 1 type: string description: References SubscriberFlex.Plan_ID value on the parent record. subscriber_ID: maxLength: 9 minLength: 1 type: string description: References SubscriberFlex.Subscriber_ID value on the parent record. update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false SubscriberFlexExportedListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberFlexExported' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberFlexExportedVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberFlexExported' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberFlexListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberFlex' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberFlexPayment: required: - subscriberFlexPayment_Key type: object properties: subscriberFlexPayment_Key: type: integer description: 'Unique identifier for each payment record on this flex account. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 calendar_Year: maxLength: 4 type: string description: References SubscriberFlex.Calendar_Year value on the parent record. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true group_ID: maxLength: 20 type: string description: References SubscriberFlex.Group_ID value on the parent record. nullable: true payment_Amount: type: number description: Amount of the associated payment. format: double nullable: true payment_Date: type: string description: Date when the payment was processed. format: date-time nullable: true payment_Description: maxLength: 128 type: string description: A description area used to provider more detail about the payment. nullable: true payment_ID: maxLength: 32 type: string description: Unique identifier assigned to the associated payment. nullable: true payment_Source: maxLength: 16 type: string description: Indicates the source of funds for this payment. GROUP - Employer Contribution or SUBSCRIBER - Employee Payment nullable: true plan_ID: maxLength: 20 type: string description: References SubscriberFlex.Plan_ID value on the parent record. nullable: true subscriber_ID: maxLength: 9 type: string description: References SubscriberFlex.Subscriber_ID value on the parent record. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false SubscriberFlexPaymentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberFlexPayment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberFlexPaymentVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberFlexPayment' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberFlexVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberFlex' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberForfeitureStatus: required: - benefit_Code - effective_Date - forfeiture_Status - plan_ID - policy_Number - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Subscribers.Subscriber_ID value on the parent record. plan_ID: maxLength: 20 minLength: 1 type: string description: Unique identifier assigned to the plan. benefit_Code: maxLength: 10 minLength: 1 type: string description: Benefit Code associated with the forfeiture. policy_Number: maxLength: 64 minLength: 1 type: string description: Policy number of the policy being forfeited. forfeiture_Status: maxLength: 32 minLength: 1 type: string description: Identifies the status of the policy forfeiture. effective_Date: type: string description: Date when the forfeiture becomes/became effective. format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true term_Date: type: string description: Date when the forfeiture expires/expired. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false SubscriberForfeitureStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberForfeitureStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberForfeitureStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberForfeitureStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberIDCode: required: - iD_Code - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: No longer in use. iD_Code: maxLength: 6 minLength: 1 type: string description: No longer in use. description: maxLength: 64 type: string description: No longer in use. nullable: true entry_Date: type: string description: No longer in use. format: date-time entry_User: maxLength: 20 type: string description: No longer in use. nullable: true update_Date: type: string description: No longer in use. format: date-time update_User: maxLength: 20 type: string description: No longer in use. nullable: true additionalProperties: false SubscriberIDCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberIDCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberIDCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberIDCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberIDHistory: required: - change_ID type: object properties: change_ID: type: integer description: 'Unique identifier for each Subscriber ID change process. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true error_Number: type: integer description: Indicates if the process returned an error during the change procedure. format: int32 nullable: true new_Subscriber_ID: maxLength: 9 type: string description: The Subscriber_ID that Old_Subscriber_ID was changed to. nullable: true old_Subscriber_ID: maxLength: 9 type: string description: The Subscriber_ID value that was changed. nullable: true table_Name: maxLength: 64 type: string description: Indicates the table that an error occurred during the change procedure. nullable: true additionalProperties: false SubscriberIDHistoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberIDHistory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberIDHistoryVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberIDHistory' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberPlanPolicy: required: - benefit_Code - plan_ID - policy_Number - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Subscribers.Subscriber_ID value on the parent record. plan_ID: maxLength: 20 minLength: 1 type: string description: Unique identifier assigned to the plan. benefit_Code: maxLength: 10 minLength: 1 type: string description: Benefit code associated with the selected plan. policy_Number: maxLength: 64 minLength: 1 type: string description: Policy number of the associated plan. entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true maturity_Date: type: string description: Date when the selected policy matures. format: date-time nullable: true paid_Through: type: string description: This date indicates how far out the policy has been paid up to. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false SubscriberPlanPolicyListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberPlanPolicy' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberPlanPolicyVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberPlanPolicy' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberPolicyStatus: required: - benefit_Code - effective_Date - plan_ID - policy_Number - policy_Status - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Subscribers.Subscriber_ID value on the parent record. plan_ID: maxLength: 20 minLength: 1 type: string description: Unique identifier assigned to the plan. benefit_Code: maxLength: 10 minLength: 1 type: string description: Benefit code associated with the selected plan. policy_Number: maxLength: 64 minLength: 1 type: string description: Policy number of the associated plan. policy_Status: maxLength: 32 minLength: 1 type: string description: 'Indicates the status of the policy (active, inactive, etc.).' effective_Date: type: string description: 'Date when the policy status goes/went into effect. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true term_Date: type: string description: Date when the policy status expires/expired. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false SubscriberPolicyStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberPolicyStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberPolicyStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberPolicyStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberPremRateSplit: required: - amount - amount_Pct - effective_Date - invoice_Level - premRate_Key - subscriber_ID - subscriberPremRateSplit_Key type: object properties: subscriberPremRateSplit_Key: type: integer description: 'Unqiue identiferi for each Premium Rate split configured for this subscriber. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 amount: type: number description: 'Specifies the amount of the rate split. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double amount_Pct: type: boolean description: 'Identifies that the rate split is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.' effective_Date: type: string description: 'Date when the associated rate split becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true invoice_Level: maxLength: 1 minLength: 1 type: string description: Identifies at which level the rate split will be invoiced. premRate_Key: type: integer description: 'References PremRate.PremRate_Key value on the referenced record. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 split_Rule: maxLength: 16 type: string description: 'Identifies the rule, or how, the the rate split will be applied.' nullable: true subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Subscribers.Subscriber_ID value on the parent record. term_Date: type: string description: Date when the associated rate split expires/expired. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false SubscriberPremRateSplitListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberPremRateSplit' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberPremRateSplitVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberPremRateSplit' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberPriorAccum: required: - allowed_Amt - allowed_Amt_Net - allowed_Amt_OON - auto_Generated - benefit_Code - benefit_Used - benefit_Used_Net - benefit_Used_OON - billed_Amt - billed_Amt_Net - billed_Amt_OON - coB_Amt - coB_Amt_Net - coB_Amt_OON - coins_Amt - coins_Amt_Net - coins_Amt_OON - copay_Amt - copay_Amt_Net - copay_Amt_OON - ded_PPO_Used - deductible_Used - deductible_Used_OON - division_ID - group_ID - not_Covered_Amt - not_Covered_Amt_Net - not_Covered_OON - out_Of_Pocket - out_Of_Pocket_Net - out_Of_Pocket_OON - plan_Type - plan_Year - subscriber_ID type: object properties: subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Subscribers.Subscriber_ID value on the parent record. group_ID: maxLength: 20 minLength: 1 type: string description: Identifier assigned to the Group associated with this Prior Accumulator. division_ID: maxLength: 20 minLength: 1 type: string description: Identifier assigned to the Division associated with this Prior Accumulator. plan_Year: maxLength: 8 minLength: 1 type: string description: Plan Year tied to this Prior Accumulator. plan_Type: maxLength: 6 minLength: 1 type: string description: Plan Type tied to this Prior Accumulator. benefit_Code: maxLength: 10 minLength: 1 type: string description: Benefit Code associated with this Prior Accumulator. added_Accum: maxLength: 1 type: string description: Identifies that this Accumulator is an Added Accumulator. nullable: true allowed_Amt: type: number description: Total Allowed amount. format: double allowed_Amt_Net: type: number description: Allowed amount that has been used In Network. format: double allowed_Amt_OON: type: number description: Allowed amount that has been used Out of Network. format: double auto_Generated: type: boolean description: Identifies that the associated prior accumulator was automatically generated. benefit_Used: type: number description: Total amount of benefit that has been used. format: double benefit_Used_Net: type: number description: Amount of benefit that has been used In Network. format: double benefit_Used_OON: type: number description: Amount of benefit that has been used Out of Network. format: double billed_Amt: type: number description: Amount that has been billed. format: double billed_Amt_Net: type: number description: Amount that has been billed In Network. format: double billed_Amt_OON: type: number description: Amount that has been billed Out of Network. format: double coB_Amt: type: number description: Total Coordination of Benefits amount that has been used. format: double coB_Amt_Net: type: number description: Coordination of Benefits amount that has been used In Network. format: double coB_Amt_OON: type: number description: Coordination of Benefits amount that has been used Out of Network. format: double coins_Amt: type: number description: Total amount of Coinsurance that has been used. format: double coins_Amt_Net: type: number description: Amount of Coinsurance that has been used In Network. format: double coins_Amt_OON: type: number description: Amount of Coinsurance that has been used Out of Network. format: double copay_Amt: type: number description: Total amount of Copay that has been used. format: double copay_Amt_Net: type: number description: Amount of Copay that has been used In Network. format: double copay_Amt_OON: type: number description: Amount of Copay that has been used Out of Network. format: double currency_ID: maxLength: 16 type: string description: Indicates the currency used for this Accumulator. nullable: true ded_PPO_Used: type: number description: Amount of deductible that has been used In Network. format: double deductible_Used: type: number description: Total amount of deductible that has been used. format: double deductible_Used_OON: type: number description: Amount of deductible that has been used Out of Network. format: double entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true not_Covered_Amt: type: number description: Total amount that is not covered. format: double not_Covered_Amt_Net: type: number description: In Network amount that is not covered. format: double not_Covered_OON: type: number description: Out of Network amount that is not covered. format: double out_Of_Pocket: type: number description: Total Out of Pocket amount that has been used. format: double out_Of_Pocket_Net: type: number description: Amount of Out of Pocket that has been used In Network. format: double out_Of_Pocket_OON: type: number description: Amount of Out of Pocket that has been used Out of Network. format: double update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false SubscriberPriorAccumListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberPriorAccum' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberPriorAccumVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberPriorAccum' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberReimbursement: required: - benefit_Code - group_ID - max_ID - plan_ID - subscriberReimbursement_Key type: object properties: subscriberReimbursement_Key: type: integer description: 'Unique identifier for each remibursement configuration for this Group and Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 benefit_Code: maxLength: 10 minLength: 1 type: string description: References BenefitCodes.Benefit_Code value on parent record. effective_Date: type: string description: Effective date of this remibursement configuration. format: date-time nullable: true entry_Date: type: string description: User that first added the record to the system. format: date-time entry_User: maxLength: 20 type: string description: Date when the record was first added to the system. nullable: true group_ID: maxLength: 20 minLength: 1 type: string description: References Groups.Group_ID value on parent record. max_ID: maxLength: 10 minLength: 1 type: string description: References PlanMaximum.Max_ID value on parent record. plan_ID: maxLength: 20 minLength: 1 type: string description: References Plans.Plan_ID value on parent record. term_Date: type: string description: Term Date of this reimbursement configuration. format: date-time nullable: true update_Date: type: string description: User that last updated the record in the system. format: date-time update_User: maxLength: 20 type: string description: Date when the record was last updated in the system. nullable: true additionalProperties: false SubscriberReimbursementListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberReimbursement' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberReimbursementVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberReimbursement' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberSponsor: required: - sponsor_ID - subscriber_ID - subscriberSponsor_Key type: object properties: subscriberSponsor_Key: type: integer description: 'Unique identifier for the Subscriber Sponsor entry. This is the primary key of the table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 effective_Date: type: string description: Beginning date for this sponsor record to apply. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true sponsor_ID: maxLength: 9 minLength: 1 type: string description: 'Identifier for the sponsor of this subscriber, matches Subscribers.Subscriber_ID.' sponsor_Relate_Code: maxLength: 8 type: string description: 'Relation of the sponsor to the subscriber, matches Relationships.Relate_Code.' nullable: true subscriber_ID: maxLength: 9 minLength: 1 type: string description: Unique ID assigned to the Subscriber term_Date: type: string description: Ending date for this sponsor record to apply. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false SubscriberSponsorListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberSponsor' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberSponsorVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberSponsor' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberWaivePremium: required: - subscriber_ID - subscriberWaivePremium_Key type: object properties: subscriberWaivePremium_Key: type: integer description: 'Unique identifier for this waived preimum. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 benefit_Code: maxLength: 10 type: string description: References BenefitCodes.Benefit_Code value on parent record. nullable: true effective_Date: type: string description: Date when the waiver becomes/became effective. format: date-time nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true ex_Code: maxLength: 6 type: string description: Specifies the Ex Code that is to be applied with the waiver. nullable: true plan_ID: maxLength: 20 type: string description: References Plans.Plan_ID value on parent record. nullable: true subscriber_ID: maxLength: 9 minLength: 1 type: string description: References Subscribers.Subscriber_ID value on the parent record. term_Date: type: string description: Date when the waiver expires/expired. format: date-time nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true additionalProperties: false SubscriberWaivePremiumListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberWaivePremium' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberWaivePremiumVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberWaivePremium' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberWritingAgent: required: - effective_Date - plan_ID - split - subscriber_ID - subscriberWritingAgent_Key - term_Date - writing_CommissionAgencyRep_Key type: object properties: subscriberWritingAgent_Key: type: integer description: 'Unique identifier for the Subscriber Writing Agent entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 effective_Date: type: string description: 'Date account is effective for the Rep Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true plan_ID: maxLength: 20 minLength: 1 type: string description: ID of the plan that the commission is associated with. split: type: number description: 'The percentage the Rep receives for this Commission. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double subscriber_ID: maxLength: 9 minLength: 1 type: string description: Unique identifier assigned to the Subscriber by the system. term_Date: type: string description: 'Date account is no longer effective for the Rep Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: date-time update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true writing_CommissionAgencyRep_Key: type: integer description: 'Unique identifier for the CommissionAgencyRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 additionalProperties: false SubscriberWritingAgentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberWritingAgent' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscriberWritingAgentVBAResponse: type: object properties: data: $ref: '#/components/schemas/SubscriberWritingAgent' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Subscribers: type: object properties: subscriber_ID: maxLength: 9 type: string description: 'Unique identifier for each family unit inside VBA. This value can be imported, assigned or randomly assigned by the system at time of record creation.' nullable: true address: maxLength: 128 type: string description: Address of the Subscriber. nullable: true address2: maxLength: 128 type: string description: Address Line 2 of the Subscriber. nullable: true billing_Cycle_ID: maxLength: 2 type: string description: Assigns a default billing cycle to be used when the Group Division 'Inv. Level' is set to 'Subscriber'. nullable: true billing_Invoice_Create: type: integer description: Specifies the number of projected billing cycles to include per invoice generation. format: int32 nullable: true city: maxLength: 32 type: string description: City of the Subscriber. nullable: true country_ID: maxLength: 8 type: string description: Country of the Subscriber. nullable: true county_Code: maxLength: 8 type: string description: County of the Subscriber. nullable: true date_Enrolled: type: string description: Date when the Subscriber was first enrolled. format: date-time nullable: true disenroll_Date: type: string description: Date when the Subscriber was disenrolled. format: date-time nullable: true email: maxLength: 256 type: string description: Email of the Subscriber. nullable: true entry_Date: type: string description: Date when the record was first added to the system. format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system. nullable: true first_Name: maxLength: 25 type: string description: First name of the Subscriber. nullable: true home_Country_Code: maxLength: 8 type: string description: Country Code for the home phone number of the Subscriber. nullable: true home_Phone: maxLength: 20 type: string description: Home phone number of the Subscriber. nullable: true issue_State: maxLength: 2 type: string description: 'For Life & Disability clients, this holds the issue state for processing taxes and reporting.' nullable: true last_Name: maxLength: 25 type: string description: Last name of the Subscriber. nullable: true middle_Name: maxLength: 25 type: string description: Middle initial of the Subscriber. nullable: true name_Suffix: maxLength: 16 type: string description: Suffix or title associated with the Subscriber. nullable: true notes: type: string description: 'No longer in use. Replaced by NotData, NoteSource and NoteReference tables.' nullable: true other_Name: maxLength: 96 type: string description: Information only. Used for custom reporting or client integrations. nullable: true pay_Period: maxLength: 2 type: string description: Number of annual pay periods for the Subscriber. This field is informational only. nullable: true pay_To_Account: type: integer description: References the FundingAccount.Account_Key and indicates the account to pay when payment reference this subscriber. format: int32 nullable: true pend_Ex_Code: maxLength: 6 type: string description: Assigns an Ex Code that can be applied to newly adjudicated Subscriber claims. nullable: true pend_Flag: maxLength: 1 type: string description: 'While active, assigned Ex Codes will be applied to any newly adjudicated Subscriber claims.' nullable: true region_Code: maxLength: 32 type: string description: Region code of the Member's primary address. nullable: true salutation: maxLength: 16 type: string description: Used by CSR to indicate the proper salutation used when communicating with the Insured. nullable: true sponsor_ID: maxLength: 9 type: string description: This holds the Subscriber ID of the subscriber that sponsored this subscriber. nullable: true sponsor_Relate_Code: maxLength: 8 type: string description: This identifies the relationship between the sponor and this subscriber. nullable: true state: maxLength: 2 type: string description: State of the Subscriber. nullable: true status: maxLength: 6 type: string description: No longer in use. nullable: true update_Date: type: string description: Date when the record was last updated in the system. format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system. nullable: true work_Country_Code: maxLength: 8 type: string description: Country Code for the work phone number of the Subscriber. nullable: true work_Phone: maxLength: 20 type: string description: Work phone number of the Subscriber. nullable: true zip_Code: maxLength: 32 type: string description: Zip Code of the Subscriber. nullable: true additionalProperties: false SubscribersListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Subscribers' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SubscribersVBAResponse: type: object properties: data: $ref: '#/components/schemas/Subscribers' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Suffix: required: - suffix1 type: object properties: suffix1: maxLength: 16 minLength: 1 type: string description: Suffix used with personal or entity names entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false SuffixListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Suffix' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SuffixVBAResponse: type: object properties: data: $ref: '#/components/schemas/Suffix' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SuspenseClaim: required: - claim_Number - suspenseClaim_Key - suspenseCriteria_Key type: object properties: suspenseClaim_Key: type: integer format: int32 claim_Number: type: integer format: int32 entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true suspenseCriteria_Key: type: integer format: int32 suspense_Date: type: string format: date-time nullable: true suspense_Status: maxLength: 16 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false SuspenseClaimList: type: object properties: claim_Number: type: integer format: int32 claimPaidAmount: type: number format: double nullable: true claim_Funded_Status: type: string nullable: true serviceLines: type: integer format: int32 nullable: true claim_Status: type: string nullable: true payor_ID: type: string nullable: true account_Key: type: integer format: int32 nullable: true group_ID: type: string nullable: true division_ID: type: string nullable: true batch_Number: type: integer format: int32 nullable: true batch_Claim: type: integer format: int32 nullable: true provider_ID: type: string nullable: true subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true payee_ID: type: string nullable: true provider_First_Name: type: string nullable: true provider_Last_Name: type: string nullable: true provider_Org_Name: type: string nullable: true payee_Name: type: string nullable: true member_First_Name: type: string nullable: true member_Last_Name: type: string nullable: true service_Date: type: string format: date-time nullable: true service_Thru: type: string format: date-time nullable: true selected: type: integer format: int32 reinsClaim: type: integer format: int32 claimAudit_Key: type: integer format: int32 nullable: true check_Batch: type: integer format: int32 nullable: true paid: type: integer format: int32 fee_Sched: type: string nullable: true suspense_Type: type: string nullable: true zelis_Suspense: type: boolean nullable: true process_Date: type: string format: date-time nullable: true process_User: type: string nullable: true suspenseClaim_Key: type: integer format: int32 nullable: true additionalProperties: false SuspenseClaimListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SuspenseClaim' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SuspenseClaimVBAResponse: type: object properties: data: $ref: '#/components/schemas/SuspenseClaim' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SuspenseCriteria: required: - adjustment_Suspense - suspenseCriteria_Key - use_Reins_Adj_Thresh - use_Reins_Loss_Thresh - zelis_Suspense type: object properties: suspenseCriteria_Key: type: integer format: int32 adjustment_Suspense: type: boolean claimAudit_Key: type: integer format: int32 nullable: true criteria_Key: type: integer format: int32 nullable: true effective_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true suspense_Clause: maxLength: 4000 type: string nullable: true suspense_Description: maxLength: 512 type: string nullable: true suspense_Option: type: integer format: int32 nullable: true suspense_Type: maxLength: 32 type: string nullable: true term_Date: type: string format: date-time nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true use_Reins_Adj_Thresh: type: boolean use_Reins_Loss_Thresh: type: boolean zelis_Suspense: type: boolean additionalProperties: false SuspenseCriteriaListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SuspenseCriteria' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SuspenseCriteriaVBAResponse: type: object properties: data: $ref: '#/components/schemas/SuspenseCriteria' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SuspenseType: required: - suspense_Type type: object properties: suspense_Type: maxLength: 32 minLength: 1 type: string description: maxLength: 512 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false SuspenseTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SuspenseType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SuspenseTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/SuspenseType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false SystemLogData: required: - log_Date - machine_ID - success - systemLogData_Key - user_ID type: object properties: systemLogData_Key: type: integer description: Key value identifying a specific system log entry format: int32 log_Action: maxLength: 256 type: string description: Action that was performed by the event that was logged nullable: true log_Data: maxLength: 4000 type: string description: Data that was deemed important from the logged event nullable: true log_Date: type: string description: Date and time the logged event occurred format: date-time log_Result: maxLength: 256 type: string description: Result of the event that was logged nullable: true log_Type: maxLength: 64 type: string description: Type of event that was logged nullable: true machine_ID: maxLength: 64 minLength: 1 type: string description: Computer the user was using when the event was logged success: type: boolean description: Flag specifying if the logged event or operation was successful user_ID: maxLength: 64 minLength: 1 type: string description: User that was logged into the application when the event was logged additionalProperties: false TableConfig: required: - fields - name type: object properties: name: minLength: 1 type: string description: Name of the table that this SearchConfig may access. fields: type: array items: $ref: '#/components/schemas/Field' description: List of fields within the table that this SearcConfig may access. additionalProperties: false TaxFilingStatus: required: - filing_Default - filing_Status type: object properties: filing_Status: type: integer description: 'Identifier for the specific filing status Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 64 type: string description: Description of the specific filing status nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true filing_Default: type: boolean description: 'Flag identifying the specific status as the default filing status Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false TaxFilingStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/TaxFilingStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false TaxFilingStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/TaxFilingStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Taxonomy: required: - taxonomy_Code - taxonomy_Key type: object properties: taxonomy_Key: type: integer description: 'Key value identifying a specific provider taxonomy Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 classification: maxLength: 256 type: string description: Classification associated with the provider taxonomy nullable: true definition: type: string description: Definition of the provider taxonomy nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true grouping: maxLength: 256 type: string description: Grouping associated with the provider taxonomy nullable: true notes: type: string description: Additional notes about the provider taxonomy nullable: true specialization: maxLength: 256 type: string description: Specialization associated with the provider taxonomy nullable: true taxonomy_Code: maxLength: 32 minLength: 1 type: string description: Code value identifying a specific provider taxonomy update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false TaxonomyGroup: required: - description - taxonomy_Group_ID - taxonomy_Type type: object properties: taxonomy_Group_ID: maxLength: 16 minLength: 1 type: string description: Identifier for the taxonomy group description: maxLength: 128 minLength: 1 type: string description: Description of the taxonomy group entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true taxonomy_Type: maxLength: 10 minLength: 1 type: string description: Type of taxonomy included in the taxonomy group update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false TaxonomyGroupDetail: required: - from_Value - taxonomy_Group_ID - taxonomyGroupDetail_Key type: object properties: taxonomyGroupDetail_Key: type: integer description: 'Key value identifying the range of taxonomies in the taxonomy group Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true from_Value: maxLength: 10 minLength: 1 type: string description: Taxonomy code value for the first taxonomy in the range taxonomy_Group_ID: maxLength: 16 minLength: 1 type: string description: Identifier for the taxonomy group thru_Value: maxLength: 10 type: string description: Taxonomy code value for the last taxonomy in the range nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false TaxonomyGroupDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/TaxonomyGroupDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false TaxonomyGroupDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/TaxonomyGroupDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false TaxonomyGroupListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/TaxonomyGroup' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false TaxonomyGroupVBAResponse: type: object properties: data: $ref: '#/components/schemas/TaxonomyGroup' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false TaxonomyListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Taxonomy' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false TaxonomyVBAResponse: type: object properties: data: $ref: '#/components/schemas/Taxonomy' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false TemplateGroupConfig: type: object properties: group_ID: type: string nullable: true eff_Date: type: string format: date-time nullable: true term_Date: type: string format: date-time nullable: true spec_Incurred_From: type: string format: date-time nullable: true spec_Incurred_Thru: type: string format: date-time nullable: true spec_Paid_From: type: string format: date-time nullable: true spec_Paid_Thru: type: string format: date-time nullable: true agg_Incurred_From: type: string format: date-time nullable: true agg_Incurred_Thru: type: string format: date-time nullable: true agg_Paid_From: type: string format: date-time nullable: true agg_Paid_Thru: type: string format: date-time nullable: true additionalProperties: false Tier: required: - dependent - insured - multimember_Tier - spouse - tier1 type: object properties: tier1: maxLength: 2 minLength: 1 type: string description: Identifier for the specific tier dependent: type: boolean description: Flag indicating the tier includes any dependents description: maxLength: 20 type: string description: Description of the specific tier nullable: true hipaA_Code: maxLength: 8 type: string description: Code used by HIPAA to identify the specific tier nullable: true insured: type: boolean description: Flag indicating the tier includes the insured max_Members: type: integer description: Maximum total members the tier allows. format: int32 nullable: true multimember_Tier: type: boolean description: Flag indicating the tier allows multiple members spouse: type: boolean description: Flag indicating the tier includes the spouse spouse_Only: maxLength: 1 type: string description: Flag indicating the tier includes only the spouse nullable: true additionalProperties: false TierListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Tier' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false TierVBAResponse: type: object properties: data: $ref: '#/components/schemas/Tier' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false TimelyFiling: required: - inpatient - timelyFiling_Key type: object properties: timelyFiling_Key: type: integer description: 'Kev value identifying a specific timely filing record Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 claim_Type: maxLength: 20 type: string description: Specifies which claim type the timely filing conditions apply to nullable: true date_Type: maxLength: 1 type: string description: Specifies which claim dates are used for timely filing nullable: true description: maxLength: 256 type: string description: Description of the timely filing conditions nullable: true division_ID: maxLength: 20 type: string description: ID of the division that the timely filing conditions apply to nullable: true effective_Date: type: string description: Date the timely filing conditions become effective format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true ex_Code: maxLength: 6 type: string description: Ex code that is applied when timely filing conditions are met nullable: true federal_ID: maxLength: 20 type: string description: Federal ID of the provider that the timely filing conditions apply to nullable: true group_ID: maxLength: 20 type: string description: ID of the group that the timely filing conditions apply to nullable: true inpatient: type: boolean description: 'Flag specifying if the timely filing applies to inpatient claims Note: This field is marked as NOT NULL in the database and therefore required by the API.' network_ID: maxLength: 10 type: string description: ID of the network that the timely filing conditions apply to nullable: true plan_ID: maxLength: 20 type: string description: ID of the plan that the timely filing conditions apply to nullable: true provider_ID: maxLength: 20 type: string description: ID of the provider that the timely filing conditions apply to nullable: true schedule_Custom: maxLength: 16 type: string description: Field specifying how the custom schedule type is defined nullable: true schedule_Frequency: type: integer description: 'Number of days, months or years specified by the frequency' format: int32 nullable: true schedule_Type: maxLength: 1 type: string description: 'Type of the schedule frequency, specifically day, month, year or custom' nullable: true term_Date: type: string description: Date the timely filing conditions terminate format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false TimelyFilingListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/TimelyFiling' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false TimelyFilingVBAResponse: type: object properties: data: $ref: '#/components/schemas/TimelyFiling' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Tolerance: required: - tolerance_Key - tolerance1 type: object properties: tolerance_Key: type: integer description: 'Unique identifier for the Tolerance entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true group_ID: maxLength: 20 type: string description: The group to which the Tolerance applies.. nullable: true payment_Method: maxLength: 20 type: string description: The subscriber's Payment Method for which the Tolerance applies. nullable: true tolerance1: type: number description: 'The amount that is used to determine if an invoice should be closed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: double update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ToleranceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Tolerance' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ToleranceVBAResponse: type: object properties: data: $ref: '#/components/schemas/Tolerance' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Tooth: required: - tooth_ID - tooth_Number - tooth_Type type: object properties: tooth_Number: type: integer description: Number indicating which tooth is specified format: int32 description: maxLength: 64 type: string description: Description of the specific tooth nullable: true quadrant: maxLength: 8 type: string description: Quadrant of the mouth where the tooth is located nullable: true tooth_ID: type: integer description: ID indicating which tooth is specified on the tooth chart format: int32 tooth_Type: maxLength: 16 minLength: 1 type: string description: Value indicating what type of tooth is specified additionalProperties: false ToothAction: required: - tooth_Action type: object properties: tooth_Action: maxLength: 8 minLength: 1 type: string description: 'Code identifying the action taken on a tooth, including cleaning, filling, bridge, crown, extraction, prosthesis or root canal' action_Ex_Code: maxLength: 6 type: string description: Ex Code that is applied when the specific action is taken nullable: true description: maxLength: 64 type: string description: Description of the action that was taken on the tooth nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ToothActionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ToothAction' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ToothActionVBAResponse: type: object properties: data: $ref: '#/components/schemas/ToothAction' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ToothChart: required: - chart_Type - chart_Value - tooth_Number type: object properties: tooth_Number: type: integer description: Number indicating which tooth is specified format: int32 chart_Type: maxLength: 8 minLength: 1 type: string description: 'Identifier for the type of chart, including Universal, Palmer or FDI two_Gigit Notation' chart_Value: maxLength: 8 minLength: 1 type: string description: Number of the specific tooth in the selected type of tooth chart additionalProperties: false ToothChartListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ToothChart' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ToothChartType: required: - chart_Type type: object properties: chart_Type: maxLength: 8 minLength: 1 type: string description: 'Identifier for the type of chart, including Universal, Palmer or FDI two_Gigit Notation' description: maxLength: 128 type: string description: Description of the type of chart nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ToothChartTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ToothChartType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ToothChartTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/ToothChartType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ToothChartVBAResponse: type: object properties: data: $ref: '#/components/schemas/ToothChart' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ToothListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Tooth' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ToothProcedure: required: - toothProcedure_Key type: object properties: toothProcedure_Key: type: integer description: 'Key value identifying a specfic dental procedure code range and action Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 effective_Date: type: string description: Date the procedure code range and tooth action relationship become effective format: date-time nullable: true end_Date: type: string description: Date the procedure code range and tooth action relationship terminate format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true from_Procedure: maxLength: 8 type: string description: First procedure code on the range covered by the tooth action nullable: true thru_Procedure: maxLength: 8 type: string description: Last procedure code on the range covered by the tooth action nullable: true tooth_Action: maxLength: 8 type: string description: 'Code identifying the action taken on a tooth, including cleaning, filling, bridge, crown, extraction, prosthesis or root canal' nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ToothProcedureListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ToothProcedure' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ToothProcedureVBAResponse: type: object properties: data: $ref: '#/components/schemas/ToothProcedure' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ToothQuadrant: required: - quadrant type: object properties: quadrant: maxLength: 8 minLength: 1 type: string description: Quadrant of the mouth where the tooth is located description: maxLength: 64 type: string description: Description of the quadrant of the mouth nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ToothQuadrantListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ToothQuadrant' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ToothQuadrantVBAResponse: type: object properties: data: $ref: '#/components/schemas/ToothQuadrant' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ToothVBAResponse: type: object properties: data: $ref: '#/components/schemas/Tooth' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false TreatmentType: required: - treatment_Type type: object properties: treatment_Type: maxLength: 8 minLength: 1 type: string description: Identifier for the specific type of treatment description: maxLength: 64 type: string description: Description of the specific type of treatment nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false TreatmentTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/TreatmentType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false TreatmentTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/TreatmentType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UCNetwork: required: - division_ID - fee_Sched - group_ID - plan_ID - state type: object properties: group_ID: maxLength: 20 minLength: 1 type: string description: Group ID that the Usual and Customary Network applies to division_ID: maxLength: 20 minLength: 1 type: string description: Division ID that the Usual and Customary Network applies to plan_ID: maxLength: 20 minLength: 1 type: string description: Plan ID that the Usual and Customary Network applies to state: maxLength: 2 minLength: 1 type: string description: State that the Usual and Customary Network applies to fee_Sched: maxLength: 8 minLength: 1 type: string description: Fee Schedule that is used for the Usual and Customary Network end_Date: type: string description: Date the Usual and Customary Network terminates format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true start_Date: type: string description: Date that the Usual and Customary Network becomes effective format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false UCNetworkListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/UCNetwork' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UCNetworkVBAResponse: type: object properties: data: $ref: '#/components/schemas/UCNetwork' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false USERFIELDSECURITY: required: - securityField_ID - user_ID type: object properties: column_Name: maxLength: 256 type: string nullable: true field_Access: maxLength: 16 type: string nullable: true field_Mask: maxLength: 512 type: string nullable: true field_Privilege_Level: type: integer format: int32 nullable: true securityField_ID: maxLength: 32 minLength: 1 type: string table_Name: maxLength: 256 type: string nullable: true user_ID: maxLength: 16 minLength: 1 type: string additionalProperties: false USERFIELDSECURITYListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/USERFIELDSECURITY' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UnitConversion: required: - from_Unit - to_Unit type: object properties: from_Unit: maxLength: 16 minLength: 1 type: string to_Unit: maxLength: 16 minLength: 1 type: string conv_Factor: type: number format: double nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false UnitConversionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/UnitConversion' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UnitConversionVBAResponse: type: object properties: data: $ref: '#/components/schemas/UnitConversion' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UnitType: required: - unit_Type type: object properties: unit_Type: maxLength: 16 minLength: 1 type: string calc_Auth_As: maxLength: 1 type: string nullable: true default_Total_Unit: maxLength: 16 type: string nullable: true entry_Date: type: string format: date-time entry_User: maxLength: 20 type: string nullable: true update_Date: type: string format: date-time update_User: maxLength: 20 type: string nullable: true additionalProperties: false UnitTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/UnitType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UnitTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/UnitType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserAmount: required: - claim_Type - detail_Column - user_ID - userAmount_Key type: object properties: userAmount_Key: type: integer description: 'ID of the User amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 claim_Type: maxLength: 20 minLength: 1 type: string description: Identifies the claim type that the amount limit will be applied to. detail_Amount: type: number description: Identifies the amount limit that will be applied. format: double nullable: true detail_Column: maxLength: 64 minLength: 1 type: string description: Identifies the claim detail that the amount limit will be applied to. effective_Date: type: string description: Date when the amount limit becomes/became effective. format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true ex_Code: maxLength: 6 type: string description: Identifies the Ex Code that will be applied to any adjudicated claim that exceeds the ‘User Limit’. nullable: true term_Date: type: string description: Date when the amount limit expires/expired. format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true user_ID: maxLength: 16 minLength: 1 type: string description: ID of the User to whom the amount will be applied. additionalProperties: false UserAmountListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/UserAmount' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserAmountProcedure: required: - userAmount_Key - userAmountProcedure_Key type: object properties: userAmountProcedure_Key: type: integer description: 'ID of the amount procedure. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true procedure_From: maxLength: 8 type: string description: Identifies the starting procedure code of the acceptable procedure code range. ‘Amount Limits’ can be further defined by a range of procedure codes. Selecting an ‘Amount Limits’ line will populate any existing procedure code limits for that line within this area. nullable: true procedure_Thru: maxLength: 8 type: string description: Identifies the ending procedure code of the acceptable procedure code range. ‘Amount Limits’ can be further defined by a range of procedure codes. Selecting an ‘Amount Limits’ line will populate any existing procedure code limits for that line within this area. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true userAmount_Key: type: integer description: 'ID of the User amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 additionalProperties: false UserAmountProcedureListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/UserAmountProcedure' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserAmountProcedureVBAResponse: type: object properties: data: $ref: '#/components/schemas/UserAmountProcedure' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserAmountVBAResponse: type: object properties: data: $ref: '#/components/schemas/UserAmount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserAuthenticationResponse: type: object properties: challengeName: type: string description: "The name of the challenge. This field will be filled if the Authentication process requires additional steps. You may programatically build application logic based on this field's value. \r\nValid values: NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login." nullable: true session: type: string description: 'The session that should pass both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters.' nullable: true authenticationResult: $ref: '#/components/schemas/AuthenticationResult' additionalProperties: false UserAuthenticationResponseVBAResponse: type: object properties: data: $ref: '#/components/schemas/UserAuthenticationResponse' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserChangeTempPasswordRequest: required: - newPassword - session - userID type: object properties: userID: minLength: 1 type: string description: The User ID newPassword: minLength: 1 type: string description: The User's new new password session: minLength: 1 type: string description: The session token returned from the original login attempt that triggered the Change Temp Password flow. additionalProperties: false UserChangeTempPasswordResponse: type: object properties: challengeName: type: string description: "The name of the challenge. This field will be filled if the Authentication process requires additional steps. You may programatically build application logic based on this field's value. \r\nValid values: NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login." nullable: true session: type: string description: 'The session that should pass both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters.' nullable: true authenticationResult: $ref: '#/components/schemas/AuthenticationResult' additionalProperties: false UserChangeTempPasswordResponseVBAResponse: type: object properties: data: $ref: '#/components/schemas/UserChangeTempPasswordResponse' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserConfirmForgotPasswordRequest: type: object properties: userID: type: string description: The User ID nullable: true password: type: string description: The new password. nullable: true confirmationCode: type: string description: The confirmation code received from the latest forgot password request. nullable: true additionalProperties: false UserConfirmForgotPasswordResponse: type: object properties: message: type: string description: Message details. nullable: true additionalProperties: false UserConfirmForgotPasswordResponseVBAResponse: type: object properties: data: $ref: '#/components/schemas/UserConfirmForgotPasswordResponse' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserForgotPasswordRequest: type: object properties: userID: type: string description: The User ID nullable: true additionalProperties: false UserForgotPasswordResponse: type: object properties: message: type: string description: Message details. nullable: true additionalProperties: false UserForgotPasswordResponseVBAResponse: type: object properties: data: $ref: '#/components/schemas/UserForgotPasswordResponse' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserGroup: required: - userGroup_Key type: object properties: userGroup_Key: type: integer description: 'ID of the User Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 50 type: string description: Description of the User Group. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false UserGroupListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/UserGroup' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserGroupMapping: required: - user_ID - userGroup_Key type: object properties: userGroup_Key: type: integer description: ID of the User Group. format: int32 user_ID: maxLength: 16 minLength: 1 type: string description: ID of the User associated with the group mapping. additionalProperties: false UserGroupMappingListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/UserGroupMapping' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserGroupMappingVBAResponse: type: object properties: data: $ref: '#/components/schemas/UserGroupMapping' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserGroupVBAResponse: type: object properties: data: $ref: '#/components/schemas/UserGroup' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserLogType: required: - log_Type - user_ID type: object properties: user_ID: maxLength: 16 minLength: 1 type: string description: ID of the User associated with the log type. log_Type: maxLength: 64 minLength: 1 type: string description: The type of logging being done additionalProperties: false UserLogTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/UserLogType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserLogTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/UserLogType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserNoteAccess: required: - note_Access - user_ID - userNoteAccess_Key type: object properties: userNoteAccess_Key: type: integer description: 'ID of the User note access. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true note_Access: type: integer description: 'Identifies the access level that will be applied to the selected note type. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 note_Type: maxLength: 8 type: string description: Identifies the note type that the selected level of access will be applied to. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true user_ID: maxLength: 20 minLength: 1 type: string description: ID of the User to whom the note access will be applied. additionalProperties: false UserNoteAccessListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/UserNoteAccess' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserNoteAccessVBAResponse: type: object properties: data: $ref: '#/components/schemas/UserNoteAccess' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UserResetPasswordRequest: required: - accessToken - previousPassword - proposedPassword type: object properties: accessToken: minLength: 1 type: string description: A valid access token that Amazon Cognito issued to the user whose password you want to change. previousPassword: minLength: 1 type: string description: The old new password. proposedPassword: minLength: 1 type: string description: The new password. additionalProperties: false Users: required: - account_Locked - administrator - audit_User - eMail_Address - iD_Card_Notification - is_SSO_User - mfA_Enabled - nav_ID_Underline - single_Use_Account - use_Windows_Authentication - user_ID - vbA_Password_Reset - vbA_User type: object properties: user_ID: maxLength: 16 minLength: 1 type: string description: User ID of the selected User. account_Locked: type: boolean description: 'This option will lock the account out of the application. To unlock the account, uncheck the box. Note: This field is marked as NOT NULL in the database and therefore required by the API.' address: maxLength: 255 type: string description: Address of the selected User. nullable: true address2: maxLength: 128 type: string description: Address line 2 of the selected User. nullable: true administrator: type: boolean description: 'Grants the User administrative rights. No security area needs to be assigned. This User will have full rights to every aspect of the application. Note: This field is marked as NOT NULL in the database and therefore required by the API.' audit_User: type: boolean description: 'This option enables logging based on the definitions provided within ‘User Log Message’. Note: This field is marked as NOT NULL in the database and therefore required by the API.' can_Set_Allowed: maxLength: 1 type: string description: 'If this option is selected, the User can override the ‘Allowed’ amount on the ‘Claim’ screen. This option applies to Users who are not flagged as an Administrator but have ‘View Access’ to the ‘Claim’ screen.' nullable: true can_Set_Co_Ins: maxLength: 1 type: string description: 'If this option is selected, the User can override the ‘Co-Ins’ amount on the ‘Claim’ screen. This option applies to Users who are not flagged as an Administrator but have ‘View Access’ to the ‘Claim’ screen.' nullable: true can_Set_Not_Covered: maxLength: 1 type: string description: 'If this option is selected, the User can override the ‘Not Covered’ amount on the ‘Claim’ screen. This option applies to Users who are not flagged as an Administrator but have ‘View Access’ to the ‘Claim’ screen.' nullable: true city: maxLength: 32 type: string description: City of the selected User's address. nullable: true claim_Maximum: type: number description: 'When an adjudicated claim’s ‘Payable Amount’ exceeds this number, the ‘User Claim Max Exceeded’ Ex Code will be applied to the claim.' format: double nullable: true country_ID: maxLength: 8 type: string description: ID of the country of the User's address. nullable: true eMail_Address: maxLength: 128 minLength: 1 type: string description: Email address of the User. entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true fax: maxLength: 20 type: string description: Fax number of the User. nullable: true fax_Country_Code: maxLength: 8 type: string description: Country code of the User's fax number. nullable: true grace_Logins: type: integer description: Identifies the number of login attempts that are allowed before the User's account is locked. format: int32 nullable: true home_Phone: maxLength: 32 type: string description: Home phone number of the User. nullable: true home_Phone_Country_Code: maxLength: 8 type: string description: Country code of the User's home phone number. nullable: true iD_Card_Notification: type: boolean description: 'This option is informational only but can be used with a custom report. Note: This field is marked as NOT NULL in the database and therefore required by the API.' is_SSO_User: type: boolean description: 'Notes that this user is utilizing SSO to authenticate and login. Note: This field is marked as NOT NULL in the database and therefore required by the API.' login_Machine: maxLength: 128 type: string description: Identifies the machine on which the User is logged in. nullable: true login_Sound: maxLength: 128 type: string description: No Longer In Use nullable: true login_Status: type: integer description: Identifies the login status of the associated User. format: int32 nullable: true mfA_Device_Name: maxLength: 256 type: string description: The device name for the authenticator being utilzied by this user. nullable: true mfA_Enabled: type: boolean description: 'Identifies that this user has enabled MFA (Multi-Factor Authentication) and a code is required to login. Note: This field is marked as NOT NULL in the database and therefore required by the API.' name: maxLength: 64 type: string description: Name of the selected User. nullable: true nav_ID_Color: type: integer description: Identifies the color that will be used for navigation fields. format: int32 nullable: true nav_ID_Type: maxLength: 2 type: string description: 'The nav. (navigation) fields are related to the functionality within VBA that allows a User to use hyperlinks to move between screens/service areas. The fields will appear blank on the ‘User System Options’ area, but the system is setup with the default functionality that is recommended by VBA.' nullable: true nav_ID_Underline: type: boolean description: 'When the box is checked, the field hyperlinks within VBA will appear underlined. When the box is unchecked, the hyperlinks will still function but will not be underlined. Note: This field is marked as NOT NULL in the database and therefore required by the API.' password: maxLength: 32 type: string description: Password of the selected User. Password requirements are set within the 'Application Settings' found from 'System Services' > 'VBA Control Panel'. nullable: true password_Expiration: type: string description: Date when the User's password will expire. format: date-time nullable: true phone: maxLength: 20 type: string description: Phone number of the User. nullable: true phone_Country_Code: maxLength: 8 type: string description: Country code of the User's phone number. nullable: true ssO_User_Name: maxLength: 256 type: string description: The SSO user name to be used during the Single Sign-On process. nullable: true single_Use_Account: type: boolean description: 'This option indicates that only one application can be opened using this login ID. Note: This field is marked as NOT NULL in the database and therefore required by the API.' state: maxLength: 2 type: string description: State of the selected User's address. nullable: true title: maxLength: 128 type: string description: Title of the selected User. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true use_Windows_Authentication: type: boolean description: 'Whether or not to use Windows Authentication to login Note: This field is marked as NOT NULL in the database and therefore required by the API.' user_Idle: type: integer description: 'Identifies the idle time, in seconds, before the application closes.' format: int32 nullable: true user_Type: maxLength: 16 type: string description: Identifies the type associated with the User. nullable: true vbA_Password_Reset: type: boolean description: 'This flag indicates that this user can change other VBA_User''s passwords. Note: This field is marked as NOT NULL in the database and therefore required by the API.' vbA_User: type: boolean description: 'Identifies that the User is a VBA User. Note: This field is marked as NOT NULL in the database and therefore required by the API.' zip_Code: maxLength: 32 type: string description: Zip code of the selected User's address. nullable: true additionalProperties: false UsersListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Users' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UsersVBAResponse: type: object properties: data: $ref: '#/components/schemas/Users' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false UsualCustomaryRateAllPercentile: type: object properties: claim_Type: type: string nullable: true zip_Code_Start: type: string nullable: true zip_Code_End: type: string nullable: true modifier: type: string nullable: true procedure_Code: type: string nullable: true effective_Date: type: string format: date-time nullable: true term_Date: type: string format: date-time nullable: true rate_50: type: number format: double nullable: true rate_60: type: number format: double nullable: true rate_70: type: number format: double nullable: true rate_75: type: number format: double nullable: true rate_80: type: number format: double nullable: true rate_85: type: number format: double nullable: true rate_90: type: number format: double nullable: true rate_95: type: number format: double nullable: true rate_Medicare: type: number format: double nullable: true additionalProperties: false UsualCustomaryRateAllPercentileListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/UsualCustomaryRateAllPercentile' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAGatewaySubscription: required: - auto_Process - notify_Me - vbaGatewaySubscription_Key type: object properties: vbaGatewaySubscription_Key: type: integer description: 'ID of the VBAGateway subscription. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 auto_Process: type: boolean description: 'Indicates that the requests associated with this subscription will be automatically processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' auto_Process_Custom_Class: maxLength: 128 type: string description: Custom class associated with the auto-process request nullable: true auto_Process_Response_Message: maxLength: 512 type: string description: Free text area where the message that will be sent as a response to auto-processed requests. nullable: true auto_Process_Status: maxLength: 32 type: string description: Indicates the status that will be assigned to auto-processed requests. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true idCard_Request_Type: maxLength: 32 type: string description: Request type used when the process involves ID Card requests nullable: true notify_Me: type: boolean description: 'Flag indicating the user would like to be notified regarding the request Note: This field is marked as NOT NULL in the database and therefore required by the API.' request_From: type: string description: Indicates the beginning date for the date range of requests that will be associated with subscription. format: date-time nullable: true request_Source: maxLength: 32 type: string description: Indicates which terminal the subscription's requests will generate from. nullable: true request_Status: maxLength: 32 type: string description: Indicates which request status will be associated with the subscription. nullable: true request_Thru: type: string description: Indicates the ending date for the date range of requests that will be associated with subscription. format: date-time nullable: true request_Type: maxLength: 32 type: string description: Indicates which type of request will be associated with the subscription. nullable: true subscription_Description: maxLength: 256 type: string description: Description of the VBAGateway subscription. nullable: true subscription_Type: maxLength: 32 type: string description: Indicates the type of the VBAGateway subscription. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true user_ID: maxLength: 32 type: string description: ID of the User associated with the VBAGateway subscription. nullable: true additionalProperties: false VBAGatewaySubscriptionDetail: required: - vbaGatewaySubscription_Key - vbaGatewaySubscriptionDetail_Key type: object properties: vbaGatewaySubscriptionDetail_Key: type: integer description: 'ID of the VBAGateway subscribtion detail. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true restriction_ID: maxLength: 512 type: string description: ID of the restriction. nullable: true restriction_Type: maxLength: 32 type: string description: Type associated with the restriction. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true vbaGatewaySubscription_Key: type: integer description: 'ID of the VBAGateway subscription. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 additionalProperties: false VBAGatewaySubscriptionDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBAGatewaySubscriptionDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAGatewaySubscriptionDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBAGatewaySubscriptionDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAGatewaySubscriptionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBAGatewaySubscription' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAGatewaySubscriptionVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBAGatewaySubscription' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAInterface: required: - vbaInterface_Key type: object properties: vbaInterface_Key: type: integer description: 'ID of the VBA interface. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 edM_Client_ID: maxLength: 32 type: string description: References the EDM (VBADataManagement) Interface value to create a hook into VBASoftware. nullable: true edM_Interface_ID: maxLength: 32 type: string description: References the EDM (VBADataManagement) Interface value to create a hook into VBASoftware. nullable: true edM_Vendor_ID: maxLength: 32 type: string description: References the EDM (VBADataManagement) Interface value to create a hook into VBASoftware. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true vbaInterface_Automate_Job_Name: maxLength: 256 type: string description: Name for the automation job. nullable: true vbaInterface_Description: type: string description: Description of the VBA interface. nullable: true vbaInterface_Direction: maxLength: 32 type: string description: 'Indicates whether the interface is outbound, inbound, or a web service.' nullable: true vbaInterface_Execute_Details: maxLength: 2048 type: string description: Free text area where the interface execution details may be described. nullable: true vbaInterface_File_Naming_Convention: maxLength: 2048 type: string description: Free text area where any naming conventions may be described. nullable: true vbaInterface_Name: maxLength: 256 type: string description: Name for the VBA interface. nullable: true vbaInterface_Owner: maxLength: 128 type: string description: Indicates the owner who is associated with the interface. nullable: true vbaInterface_Schedule: maxLength: 2048 type: string description: Free text area where the interface schedule may be described. nullable: true vbaInterface_Status: maxLength: 32 type: string description: Indicates the current status of the interface. nullable: true vbaInterface_Type: maxLength: 32 type: string description: Indicates the type of interface being configured. nullable: true vbaInterface_Vendor: maxLength: 32 type: string description: Indicates the vendor who is associated with the interface. nullable: true additionalProperties: false VBAInterfaceIDCode: required: - iD_Code - type - vbaInterface_Key type: object properties: vbaInterface_Key: type: integer description: 'ID of the interface. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 iD_Code: maxLength: 16 minLength: 1 type: string description: ID code associated with the interface item. type: maxLength: 16 minLength: 1 type: string description: Type associated with the interface item. description: type: string description: Description of the interface item. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true surrogate_ID_Code: maxLength: 16 type: string description: System Configuration Values used by VBA Engineers to group ID Codes with similar functionality. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false VBAInterfaceIDCodeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBAInterfaceIDCode' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAInterfaceIDCodeVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBAInterfaceIDCode' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAInterfaceListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBAInterface' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAInterfaceMapType: required: - map_Type - vbaInterface_Key type: object properties: vbaInterface_Key: type: integer description: 'ID of the VBA interface. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 map_Type: maxLength: 16 minLength: 1 type: string description: Name for the map type. description: type: string description: Description of the map type. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true surrogate_Map_Type: maxLength: 16 type: string description: System Configuration Values used by VBA Engineers to group EDICode Map Types with similar functionality. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false VBAInterfaceMapTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBAInterfaceMapType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAInterfaceMapTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBAInterfaceMapType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAInterfaceStatus: required: - vbaInterface_Status type: object properties: vbaInterface_Status: maxLength: 32 minLength: 1 type: string description: Name for the VBA interface status. description: maxLength: 128 type: string description: Description of the VBA interface status. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false VBAInterfaceStatusListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBAInterfaceStatus' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAInterfaceStatusVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBAInterfaceStatus' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAInterfaceType: required: - vbaInterface_Type type: object properties: vbaInterface_Type: maxLength: 32 minLength: 1 type: string description: Name for the VBA interface type. description: maxLength: 128 type: string description: Description of the VBA interface type. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false VBAInterfaceTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBAInterfaceType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAInterfaceTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBAInterfaceType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAInterfaceVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBAInterface' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAInterfaceVendor: required: - vbaInterface_Vendor type: object properties: vbaInterface_Vendor: maxLength: 32 minLength: 1 type: string description: Name for the VBA interface vendor. description: maxLength: 128 type: string description: Description of the VBA interface vendor. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false VBAInterfaceVendorListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBAInterfaceVendor' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAInterfaceVendorVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBAInterfaceVendor' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAProblemDetails: type: object properties: detail: type: string description: A human-readable explanation specific to this occurrence of the problem. nullable: true instance: type: string description: "A URI reference that identifies the specific occurrence of the problem.It may\r\nor may not yield further information if dereferenced." nullable: true status: type: integer description: "The HTTP status code([RFC7231], Section 6) generated by the origin server for\r\nthis occurrence of the problem." format: int32 title: type: string description: "A short, human-readable summary of the problem type.It SHOULD NOT change from\r\noccurrence to occurrence of the problem, except for purposes of localization(e.g.,\r\nusing proactive content negotiation; see[RFC7231], Section 3.4)." nullable: true type: type: string description: "A URI reference [RFC3986] that identifies the problem type. This specification\r\nencourages that, when dereferenced, it provide human-readable documentation for\r\nthe problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member\r\nis not present, its value is assumed to be \"about:blank\"." nullable: true additionalProperties: false VBAProcess: required: - vbaProcess_Key - vbaProcess_Type type: object properties: vbaProcess_Key: type: integer description: 'Unique Identifier for the VBAProcess table Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 vbaProcess_Type: maxLength: 32 minLength: 1 type: string description: Type used to determine the process that triggers. description: maxLength: 512 type: string description: Description of the process. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true process_End: type: string description: Date and time the process ended. format: date-time nullable: true process_Result: maxLength: 32 type: string description: Result of the process. nullable: true process_Start: type: string description: Date and time the process started. format: date-time nullable: true process_User: maxLength: 20 type: string description: User that started the process. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false VBAProcessLog: required: - vbaProcess_Key - vbaProcess_Type - vbaProcessLog_Key type: object properties: vbaProcessLog_Key: type: integer description: 'Unique Identifier for the VBAProcessLog table Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true log_Message: type: string description: Message provided from the process. nullable: true log_Reference_Column1: maxLength: 128 type: string description: A column that the log references. nullable: true log_Reference_Column2: maxLength: 128 type: string description: A column that the log references. nullable: true log_Reference_Column3: maxLength: 128 type: string description: A column that the log references. nullable: true log_Reference_Column4: maxLength: 128 type: string description: A column that the log references. nullable: true log_Reference_Column5: maxLength: 128 type: string description: A column that the log references. nullable: true log_Reference_Value1: type: string description: A value that the log references. nullable: true log_Reference_Value2: type: string description: A value that the log references. nullable: true log_Reference_Value3: type: string description: A value that the log references. nullable: true log_Reference_Value4: type: string description: A value that the log references. nullable: true log_Reference_Value5: type: string description: A value that the log references. nullable: true log_Result: maxLength: 32 type: string description: Result of the process. nullable: true log_Type: maxLength: 32 type: string description: Type of the process. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true vbaProcess_Key: type: integer description: 'Unique Identifier for the VBAProcess table Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 vbaProcess_Type: maxLength: 32 minLength: 1 type: string description: Type used to determine the process that triggers. additionalProperties: false VBAProcessLogListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBAProcessLog' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAProcessLogVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBAProcessLog' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAProcessParameter: required: - parameter_Name - parameter_Type - process_Automation - vbaProcess_Key - vbaProcess_Type - vbaProcessParameter_Key type: object properties: vbaProcessParameter_Key: type: integer description: 'Unique Identifier for the VBAProcessParameter table Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 end_Date: type: string description: Date and time the process ended. format: date-time nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true parameter_Name: maxLength: 64 minLength: 1 type: string description: Name of the parameter passed. parameter_Type: maxLength: 32 minLength: 1 type: string description: Type of the parameter passed. parameter_Value1: type: string description: A value passed to the process. nullable: true parameter_Value10: type: string description: A value passed to the process. nullable: true parameter_Value11: type: string description: A value passed to the process. nullable: true parameter_Value12: type: string description: A value passed to the process. nullable: true parameter_Value2: type: string description: A value passed to the process. nullable: true parameter_Value3: type: string description: A value passed to the process. nullable: true parameter_Value4: type: string description: A value passed to the process. nullable: true parameter_Value5: type: string description: A value passed to the process. nullable: true parameter_Value6: type: string description: A value passed to the process. nullable: true parameter_Value7: type: string description: A value passed to the process. nullable: true parameter_Value8: type: string description: A value passed to the process. nullable: true parameter_Value9: type: string description: A value passed to the process. nullable: true process_Automation: type: boolean description: 'Flag is set by Process Automation to show it has been processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.' start_Date: type: string description: Date and time the process started. format: date-time nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true vbaProcess_Key: type: integer description: 'Unique Identifier for the VBAProcess table Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 vbaProcess_Type: maxLength: 32 minLength: 1 type: string description: Type used to determine the process that triggers. additionalProperties: false VBAProcessParameterVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBAProcessParameter' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBAProcessVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBAProcess' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_AppInfo: type: object properties: version: type: string nullable: true files: type: array items: $ref: '#/components/schemas/FileDetail' nullable: true path: type: string nullable: true sha512: type: string nullable: true releaseNotes: type: string nullable: true releaseDate: type: string format: date-time additionalProperties: false VBA_AppInfoVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBA_AppInfo' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_Auth: type: object properties: provider_Last_Name: type: string nullable: true provider_First_Name: type: string nullable: true provider_Org_Name: type: string nullable: true provider_Entity_ID: type: string nullable: true provider_Type: type: string nullable: true payee_Name: type: string nullable: true member_Last_Name: type: string nullable: true member_First_Name: type: string nullable: true member_Birth_Date: type: string format: date-time nullable: true member_VIP_Flag: type: boolean auth_Adjust_Count: type: integer format: int32 nullable: true auth_Ref_Count: type: integer format: int32 nullable: true authDetail: $ref: '#/components/schemas/Auth' additionalProperties: false VBA_AuthVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBA_Auth' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_CDC_Members: type: object properties: subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true last_Name: type: string nullable: true first_Name: type: string nullable: true relationship: type: string nullable: true birth_Date: type: string format: date-time nullable: true date_Enrolled: type: string format: date-time nullable: true disenroll_Date: type: string format: date-time nullable: true sex: type: string nullable: true adult_Child: type: string nullable: true other_Insurance: type: boolean nullable: true adult_Dependent: type: boolean nullable: true notes: type: string nullable: true entry_Date: type: string format: date-time nullable: true entry_User: type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: type: string nullable: true alternate_ID: type: string nullable: true viP_Flag: type: string nullable: true pend_Flag: type: string nullable: true pend_Ex_Code: type: string nullable: true other_Name: type: string nullable: true pre_Exist: type: string nullable: true pre_Exist_End: type: string format: date-time nullable: true pre_Exist_Ex_Code: type: string nullable: true student: type: string nullable: true date_Of_Death: type: string format: date-time nullable: true marital_Status: type: string nullable: true ethnicity_Code: type: string nullable: true middle_Name: type: string nullable: true name_Suffix: type: string nullable: true salutation: type: string nullable: true ssn: type: string nullable: true unique_ID: type: string nullable: true access_Code: type: string nullable: true student_End: type: string format: date-time nullable: true adult_Dependent_End: type: string format: date-time nullable: true height: type: integer format: int32 nullable: true weight: type: integer format: int32 nullable: true continue_Coverage: type: boolean nullable: true continue_Coverage_Ex_Code: type: string nullable: true continue_Coverage_End_Date: type: string format: date-time nullable: true credible_Coverage: type: integer format: int32 nullable: true coverage_Type: type: string nullable: true use_Member_Plan_Year: type: boolean nullable: true plan_Year_Frequency: type: integer format: int32 nullable: true plan_Year_Frequency_Type: type: string nullable: true creditable_Coverage_Start: type: string format: date-time nullable: true creditable_Coverage_End: type: string format: date-time nullable: true initial_Volume_Salary_Pct: type: boolean nullable: true initial_Volume: type: number format: double nullable: true smoker: type: boolean nullable: true additionalProperties: false VBA_CDC_MembersListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_CDC_Members' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_CDC_Subenrollment: type: object properties: subscriber_ID: type: string nullable: true group_ID: type: string nullable: true division_ID: type: string nullable: true group_Coverage_Start: type: string format: date-time nullable: true start_Date: type: string format: date-time nullable: true end_Date: type: string format: date-time nullable: true date_Employed: type: string format: date-time nullable: true term_Date: type: string format: date-time nullable: true policy_Number: type: string nullable: true lifetime_Max: type: number format: double nullable: true annual_Max: type: number format: double nullable: true original_Enrollment_Date: type: string format: date-time nullable: true eligibility_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time nullable: true entry_User: type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: type: string nullable: true paid_Through: type: string format: date-time nullable: true additionalProperties: false VBA_CDC_SubenrollmentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_CDC_Subenrollment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_CDC_SubenrollmentPlan: type: object properties: subscriber_ID: type: string nullable: true group_ID: type: string nullable: true division_ID: type: string nullable: true group_Coverage_Start: type: string format: date-time nullable: true start_Date: type: string format: date-time nullable: true plan_ID: type: string nullable: true plan_Start: type: string format: date-time nullable: true plan_End: type: string format: date-time nullable: true tier: type: string nullable: true dollar_Amount: type: number format: double nullable: true use_Volume_Scale: type: boolean nullable: true paid_Through: type: string format: date-time nullable: true entry_Date: type: string format: date-time nullable: true entry_User: type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: type: string nullable: true reason_ID: type: integer format: int32 nullable: true ltC_Daily_Benefit_Amount: type: number format: double nullable: true ltC_Monthly_Benefit_Amount: type: number format: double nullable: true ltC_Lifetime_Max_Days: type: integer format: int32 nullable: true ltC_Lifetime_Max_Years: type: integer format: int32 nullable: true ltC_Lifetime_Max_Amount: type: number format: double nullable: true writing_CommissionAgencyRep_Key: type: integer format: int32 nullable: true application_Received_Date: type: string format: date-time nullable: true additionalProperties: false VBA_CDC_SubenrollmentPlanListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_CDC_SubenrollmentPlan' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_CDC_SubenrollmentRider: type: object properties: subscriber_ID: type: string nullable: true group_ID: type: string nullable: true division_ID: type: string nullable: true group_Coverage_Start: type: string format: date-time nullable: true start_Date: type: string format: date-time nullable: true plan_ID: type: string nullable: true plan_Start: type: string format: date-time nullable: true benefit_Code: type: string nullable: true from_Date: type: string format: date-time nullable: true thru_Date: type: string format: date-time nullable: true entry_Date: type: string format: date-time nullable: true entry_User: type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: type: string nullable: true volume: type: number format: double nullable: true employee_Contribution: type: number format: double nullable: true employee_Contribution_Pct: type: boolean nullable: true external_ID: type: string nullable: true use_Volume_Scale: type: boolean nullable: true billing_Member_Seq_Override: type: string nullable: true initial_Volume: type: number format: double nullable: true initial_Volume_Salary_Pct: type: boolean nullable: true use_Employee_Age: type: boolean nullable: true original_CommissionAgencyRep_Key: type: integer format: int32 nullable: true new_CommissionAgencyRep_Key: type: integer format: int32 nullable: true use_GI_Volume_Min_Max: type: boolean nullable: true ltC_Daily_Benefit_Amount: type: number format: double nullable: true ltC_Monthly_Benefit_Amount: type: number format: double nullable: true ltC_Lifetime_Max_Days: type: integer format: int32 nullable: true ltC_Lifetime_Max_Years: type: integer format: int32 nullable: true ltC_Lifetime_Max_Amount: type: number format: double nullable: true additionalProperties: false VBA_CDC_SubenrollmentRiderListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_CDC_SubenrollmentRider' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_CDC_Subscribers: type: object properties: subscriber_ID: type: string nullable: true last_Name: type: string nullable: true first_Name: type: string nullable: true address: type: string nullable: true city: type: string nullable: true state: type: string nullable: true date_Enrolled: type: string format: date-time nullable: true disenroll_Date: type: string format: date-time nullable: true status: type: string nullable: true notes: type: string nullable: true entry_Date: type: string format: date-time nullable: true entry_User: type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: type: string nullable: true pend_Flag: type: string nullable: true pend_Ex_Code: type: string nullable: true other_Name: type: string nullable: true home_Phone: type: string nullable: true work_Phone: type: string nullable: true zip_Code: type: string nullable: true middle_Name: type: string nullable: true name_Suffix: type: string nullable: true salutation: type: string nullable: true county_Code: type: string nullable: true address2: type: string nullable: true country_ID: type: string nullable: true home_Country_Code: type: string nullable: true work_Country_Code: type: string nullable: true billing_Cycle_ID: type: string nullable: true billing_Invoice_Create: type: integer format: int32 nullable: true region_Code: type: string nullable: true pay_To_Account: type: integer format: int32 nullable: true email: type: string nullable: true pay_Period: type: string nullable: true sponsor_ID: type: string nullable: true sponsor_Relate_Code: type: string nullable: true issue_State: type: string nullable: true additionalProperties: false VBA_CDC_SubscribersListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_CDC_Subscribers' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_ClaimTimeline: type: object properties: sort: type: integer format: int32 transaction_Type: type: string nullable: true transaction_Date: type: string format: date-time nullable: true pre_Process_Image: type: string nullable: true pre_Process_Arrow_Right: type: string nullable: true pre_Process_Arrow_Down: type: string nullable: true pre_Process_Description: type: string nullable: true post_Process_Image: type: string nullable: true post_Process_Arrow_Right: type: string nullable: true post_Process_Arrow_Left: type: string nullable: true post_Process_Arrow_Down: type: string nullable: true post_Process_Description: type: string nullable: true post_Payment_Image: type: string nullable: true post_Payment_Arrow_Left: type: string nullable: true post_Payment_Arrow_Down: type: string nullable: true post_Payment_Description: type: string nullable: true additionalProperties: false VBA_ClaimTimelineListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_ClaimTimeline' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_Client: type: object properties: id: type: string nullable: true name: type: string nullable: true clientId: type: string nullable: true clientCode: type: string nullable: true databaseConnections: type: array items: $ref: '#/components/schemas/DatabaseConnection' nullable: true additionalProperties: false VBA_ClientEnvironment: type: object properties: databaseName: type: string nullable: true ssoConfigs: type: array items: $ref: '#/components/schemas/VBA_SSOLoginConfig' nullable: true additionalProperties: false VBA_ClientEnvironmentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_ClientEnvironment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_ClientListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_Client' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_ClientVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBA_Client' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_CommissionRateSubscriber: type: object properties: commissionRate_Key: type: integer description: The Commission Rate Key asigned to this Subscriber format: int32 nullable: true subscriber_ID: type: string description: The subscriber's unique id nullable: true first_Name: type: string description: First name nullable: true last_Name: type: string description: Last name nullable: true additionalProperties: false VBA_CommissionRateSubscriberListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_CommissionRateSubscriber' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_DisabilityAdvisor: type: object properties: description: type: string description: Used to give a description for this episode of care. nullable: true sickTime: type: boolean description: This flag identifies that there is sick time during this disability. sickTimeFrom: type: string description: This is the begin date of the sick time payment. format: date-time nullable: true sickTimeThru: type: string description: This is the end date of the sick time payment. format: date-time nullable: true sickTimeExCode: type: string description: This is the explanation code that will be applied to the sick time payments during this disability. nullable: true vacation: type: boolean description: This flag identifies that there is vacation during this disability. vacationFrom: type: string description: This is the begin date of the vacation payment. format: date-time nullable: true vacationThru: type: string description: This is the end date of the vacation payment. format: date-time nullable: true vacationExCode: type: string description: This is the explanation code that will be applied to the vacation payments during this disability. nullable: true salaryContinuation: type: boolean description: This flag identifies that salary continuation is part of the payment during this disability. salaryContinuationFrom: type: string description: This is the begin date of the salary continuation payment. format: date-time nullable: true salaryContinuationThru: type: string description: This is the end date of the salary continuation payment. format: date-time nullable: true salaryContinuationExCode: type: string description: This is the explanation code that will be applied to the salary continuation payments during this disability. nullable: true partialDisability: type: boolean description: This will identify if this is a partial disability payment. Partial Disability payments have additional tax and payment rules applied during adjudication. partialDisabilityHours: type: boolean description: This flag will identify if there is partial disability hours involved during the claim. imageNumber: type: string nullable: true imageNumber2: type: string nullable: true imageNumber3: type: string nullable: true imageNumber4: type: string nullable: true receivedDate: type: string format: date-time nullable: true lastDayWorked: type: string format: date-time nullable: true diagnosis1: type: string description: This identifies the primary diagnosis for this disability. nullable: true diagnosis2: type: string description: This identifies additional diagnosis for this disability. nullable: true dateOfSurgery: type: string description: This identifies the date of surgery for disability due to surgery. format: date-time nullable: true waitingPeriod: type: integer description: This is the number of waiting period days that will be assigned to the waiting period payment on this disability. format: int32 nullable: true rollupWaitingPeriod: type: boolean description: This flag if set will create the Waiting Period in one claim. admitDate: type: string description: This identifies the date the member was admitted to the Hospital if hospitalized as part of this disability. format: date-time nullable: true applyExtension: type: boolean description: This will let the Disability Payment Creator know that the created payments need to have a reminder Ex Code applied to the final two payments. applyExtensionExCode: type: string description: This is the Ex Code that is applied to the final two payments created by the Disability Payment Creator if the Apply Extension option is selected. nullable: true closureEffectiveDate: type: string description: This is an information only field that allows the tracking of the Closure Effective Date. format: date-time nullable: true dateFirstAttended: type: string description: 'This identifies the date the member first visited the Physician. This field, in combination with Disabled by Physician Date and Last Day Worked, create the Disability Date for the Member.' format: date-time nullable: true disabledByPhysician: type: string description: 'This identifies the date the member was disabled by the Physician. This field, in combination with First Attended Physician Date and Last Day Worked, create the Disability Date for the Member.' format: date-time nullable: true dob: type: string description: This is the Members Birth Date. format: date-time nullable: true duringEmployment: type: boolean description: Flag to identify if this disability happened while member was at work. surgery: type: integer description: Used to identify if surgery is involved in this disability. format: int32 nullable: true typeOfSurgery: type: string description: This is the procedure code of the surgery being performed for this disability. nullable: true disabilityType: type: string description: This identifies the type of disability (Injury or Illness). nullable: true typeOfDelivery: type: string description: This will identify the type of delivery that is performed as a result of pregnancy. nullable: true numberOfPayments: type: integer description: This will identify the number of payments that will be involved during this claim. format: int32 nullable: true waiveWaitingPeriod: type: boolean description: This will identify whether the Waive Waiting Period option was selected. stateTax: type: number description: 'This will identify the state withhold amount for each payment. If tax calculation module is enabled, this option will be ignored.' format: double nullable: true federalWithheld: type: number description: This will hold the amount for the Federal tax withheld from each payment. format: double nullable: true fica: type: number description: This will hold the FICA tax deduction for each payment. format: double nullable: true subscriberID: type: string description: This is the member’s unique system ID. nullable: true memberSeq: type: string description: This is the member's sequence number. nullable: true firstName: type: string description: This is the Members First Name. nullable: true lastName: type: string description: This is the Members Last Name. nullable: true groupID: type: string description: This is the Members Last Name. nullable: true planID: type: string description: This will identify the plan under which this disability falls. nullable: true planType: type: string description: This is the Plan Type associated with the Plan ID. nullable: true planTypeLTD: type: boolean description: This is the Plan Type identifier for Long Term Disability. exceedReturnToWork: type: boolean description: This will be the Exceed Return To Work flag associated with the case. exceedMax: type: boolean description: This will indicate if max exceeded in disability payment creation. followupDate: type: string description: This will be the date the case is being followed up on. format: date-time nullable: true followupExCode: type: string description: This will identify the follow-up ExCode to be used. nullable: true includeReturnToWork: type: boolean description: This will identify if the claim should include return to work. scd: type: boolean description: This is an SCD Payment identifier. paymentInterval: type: integer description: 'This identifies the payment interval for the disability claim (e.g., 5-day, 7-day, Monthly).' format: int32 nullable: true surgeryExCode: type: string description: This is the explanation code attached to the surgery payments during this disability claim. nullable: true jobType: type: string description: 'This will indicate the type of job associated with the disability (e.g., Sedentary, Light, Medium, Heavy).' nullable: true waitingPeriodExCode: type: string description: This is the explanation code applied to the waiting period payment for this disability. nullable: true includeWaitingPeriod: type: boolean description: This will identify if the claim includes waiting period coverage. maxDisability: type: integer description: This will identify the maximum amount of disability payments for this claim. format: int32 nullable: true includeInMax: type: boolean description: This flag indicates if the waiting period is included in the maximum disability calculation. firstDayHospital: type: boolean description: This flag identifies if the first day in the hospital is included in the disability coverage. liabilityInjury: type: boolean description: This flag identifies if the injury was due to liability. pay_To: type: string nullable: true mail_To: type: string nullable: true exCode: type: string nullable: true hospitalized: type: boolean pregnancy: type: boolean description: This flag identifies if the disability is related to pregnancy. dischargeDate: type: string description: This identifies the date of discharge from the hospital. format: date-time nullable: true expectedTypicalDuration: type: integer description: This identifies the expected typical duration of the disability. format: int32 nullable: true dateOfDelivery: type: string description: This identifies the date of the delivery for pregnancy-related disability. format: date-time nullable: true returnToWork: type: string description: This identifies the date the employee returned to work after the disability. format: date-time nullable: true ltdEffectiveDate: type: string description: This identifies the date the long-term disability becomes effective. format: date-time nullable: true ltdPacketDate: type: string description: This identifies the date the long-term disability packet was sent. format: date-time nullable: true depSSDIEndDate: type: string description: This identifies the end date for dependent SSDI coverage. format: date-time nullable: true lastPhysicianWarrantDate: type: string description: This identifies the last warrant date for the physician for this claim. format: date-time nullable: true exhaustDate: type: string description: This identifies the exhaustion date for the disability claim. format: date-time nullable: true physicianReturnToWork: type: string description: This is the Return to Work date identified by the Physician at the start of disability.This may or may not be the actual date the member returns to work. format: date-time nullable: true disabilityPayThroughDay: type: integer description: This identifies the disability pay-through day for this claim. format: int32 nullable: true overpaymentTotal: type: number description: This will track the total overpayment amount for the disability claim. format: double nullable: true overpaymentDeduction: type: number description: This will track the deduction amount for overpayments. format: double nullable: true overpaymentExCode: type: string description: This is the explanation code for the overpayment during the disability. nullable: true paymentDuration: type: integer description: 'This will identify the duration of payments for the disability (e.g., Weekly, Monthly).' format: int32 nullable: true processByDisabilityDate: type: boolean description: This will identify if the claim needs to be processed based on the disability date. disability_Date: type: string description: This identifies the actual disability date for this claim. format: date-time nullable: true diagnosticCodeType: type: string description: This identifies the diagnostic code type for this claim. nullable: true preview: type: boolean description: This flag indicates if the options being sent will only product a list of payments in memory and not create them in the database. Allows front-end to review their options before actually creating the payments. deductions: type: array items: $ref: '#/components/schemas/VBA_DisabilityAdvisorDeduction' description: This is the list of any deductions that will be applied to each payment. nullable: true additionalProperties: false VBA_DisabilityAdvisorDeduction: type: object properties: deductionType: type: string description: 'This is the deduction to be applied, this must be a valid value from the DeductionType table.' nullable: true deductionPct: type: boolean description: This indicates if the value in DeductionAmount is a Pct deduction. deductionAmount: type: number description: 'This is the amount of the Deduction. If DeductionPct is true, then this value must be between 0 - 100.' format: double nullable: true caseNumber: type: string description: This is the Case Number for the deduction. Information only. nullable: true thirdPartyPayment: type: boolean description: This indicates if the deduction should spawn a 3rd party payment which is a separate Professional claim for the deduction. providerID: type: string description: 'When ThirdPartyPayment is true, this is the ProviderID for the 3rd party payment.' nullable: true preTax: type: boolean description: This indicates if the deduction should be applied before taxes are calculated. preGross: type: boolean description: This indicates if the deduction should be applied before the gross amount is calculated. additionalProperties: false VBA_FundingAccountClaimInfo: type: object properties: claim_Number: type: integer format: int32 claimPaidAmount: type: number format: double claim_Funded_Status: type: string nullable: true serviceLines: type: integer format: int32 claim_Status: type: string nullable: true payor_ID: type: string nullable: true account_Key: type: integer format: int32 nullable: true group_ID: type: string nullable: true division_ID: type: string nullable: true batch_Number: type: integer format: int32 nullable: true batch_Claim: type: integer format: int32 nullable: true provider_ID: type: string nullable: true subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true payee_ID: type: string nullable: true provider_First_Name: type: string nullable: true provider_Last_Name: type: string nullable: true org_Name: type: string nullable: true payee_Name: type: string nullable: true member_First_Name: type: string nullable: true member_Last_Name: type: string nullable: true first_Name: type: string nullable: true last_Name: type: string nullable: true long_Name: type: string nullable: true iD_Code_Data: type: string nullable: true service_Date: type: string format: date-time nullable: true service_Thru: type: string format: date-time nullable: true send_Check_To: type: string nullable: true payToId: type: string nullable: true payToName: type: string nullable: true selected: type: integer format: int32 specClaim: type: integer format: int32 reinsClaim: type: integer format: int32 current_Loss_Amount: type: number format: double accumulated_Loss_Amount: type: number format: double over_Spec_Amount: type: number format: double include_In_Spec_Calc: type: integer format: int32 partial_Over_Spec: type: integer format: int32 over_Reporting_Limit: type: integer format: int32 received_Date: type: string format: date-time nullable: true processed_Date: type: string format: date-time nullable: true claim_Type: type: string nullable: true additionalProperties: false VBA_FundingAccountClaimInfoListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_FundingAccountClaimInfo' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_FundingRequestClaimSummary: type: object properties: claimNumber: type: integer description: Gets or sets the claim number. format: int32 batchNumber: type: integer description: Gets or sets the batch number. format: int32 batchClaim: type: integer description: Gets or sets the batch claim. format: int32 claimPaidAmount: type: number description: Gets or sets the claim paid amount. format: double claimFundedStatus: type: string description: Gets or sets the claim funded status. nullable: true claimStatus: type: string description: Gets or sets the claim status. nullable: true funded: type: boolean description: Gets or sets a value indicating whether the claim is funded. fundedDate: type: string description: Gets or sets the funded date. format: date-time nullable: true processedDate: type: string description: Gets or sets the processed date. format: date-time nullable: true requestAmount: type: number description: Gets or sets the request amount. format: double fundedAmount: type: number description: Gets or sets the funded amount. format: double additionalProperties: false VBA_FundingRequestClaimSummaryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_FundingRequestClaimSummary' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_GroupContract: type: object properties: total_Subscribers: type: integer format: int32 nullable: true eligible_Subscribers: type: integer format: int32 nullable: true total_Members: type: integer format: int32 nullable: true eligible_Members: type: integer format: int32 nullable: true groupContractDetail: $ref: '#/components/schemas/GroupContract' additionalProperties: false VBA_GroupContractEnrollmentSummary: type: object properties: group_ID: type: string nullable: true division_ID: type: string nullable: true coverage_Start: type: string format: date-time coverage_End: type: string format: date-time nullable: true totalSubscribers: type: integer format: int32 totalMembers: type: integer format: int32 totalSubscribersCurrent: type: integer format: int32 totalMembersCurrent: type: integer format: int32 additionalProperties: false VBA_GroupContractEnrollmentSummaryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_GroupContractEnrollmentSummary' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_GroupContractListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_GroupContract' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_GroupDisenrollAffectedClaims: type: object properties: group_ID: type: string nullable: true division_ID: type: string nullable: true subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true claim_Number: type: integer format: int32 diagnostic_Code_Type: type: string nullable: true diagnostic_Code1: type: string nullable: true diagnostic_Code2: type: string nullable: true provider_ID: type: string nullable: true service_Date: type: string format: date-time nullable: true service_Thru: type: string format: date-time nullable: true check_Batch: type: integer format: int32 nullable: true check_Number: type: string nullable: true claimPaid: type: integer format: int32 claimPaidAmount: type: number format: double nullable: true additionalProperties: false VBA_GroupDisenrollAffectedClaimsListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_GroupDisenrollAffectedClaims' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_GroupEnrollmentSummary: type: object properties: totalSubscribers: type: integer format: int32 totalMembers: type: integer format: int32 totalSubscribersCurrent: type: integer format: int32 totalMembersCurrent: type: integer format: int32 additionalProperties: false VBA_GroupEnrollmentSummaryVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBA_GroupEnrollmentSummary' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_GroupIDCardSelection: type: object properties: group_ID: type: string nullable: true division_ID: type: string nullable: true subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true first_Name: type: string nullable: true last_Name: type: string nullable: true relationship: type: string nullable: true selected: type: integer format: int32 duplicates: type: integer format: int32 additionalProperties: false VBA_GroupIDCardSelectionVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBA_GroupIDCardSelection' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_MembersDisabilityTaxSummary: type: object properties: total: type: number description: The total amount of disability tax. format: double paid: type: number description: The amount of disability tax that has been paid. format: double payable: type: number description: The amount of disability tax that is payable. format: double inBatch: type: number description: The amount of disability tax in batch. format: double denied: type: number description: The amount of disability tax that has been denied. format: double totalDays: type: number description: The total number of days for which disability benefits were claimed. format: double paidDays: type: number description: The number of days for which disability benefits have been paid. format: double payableDays: type: number description: The number of days for which disability benefits are payable. format: double inBatchDays: type: number description: The number of days for which disability benefits are in batch. format: double deniedDays: type: number description: The number of days for which disability benefits have been denied. format: double benefitTotalAmount: type: number description: The total amount of disability benefits claimed. format: double benefitPaidAmount: type: number description: The amount of disability benefits paid. format: double benefitPayableAmount: type: number description: The amount of disability benefits payable. format: double benefitInBatchAmount: type: number description: The amount of disability benefits in batch. format: double deductionTotalAmount: type: number description: The total amount of deductions claimed for disability tax. format: double deductionPaidAmount: type: number description: The amount of deductions paid for disability tax. format: double deductionPayableAmount: type: number description: The amount of deductions payable for disability tax. format: double deductionInBatchAmount: type: number description: The amount of deductions in batch for disability tax. format: double taxableTotalAmount: type: number description: The total amount of taxable disability benefits. format: double taxablePaidAmount: type: number description: The amount of taxable disability benefits paid. format: double taxablePayableAmount: type: number description: The total amount of taxable benefits payable for the member's disability tax summary. format: double taxableInBatchAmount: type: number description: The total amount of taxable benefits in batch for the member's disability tax summary. format: double federalTaxTotalAmount: type: number description: The total federal tax amount for the member's disability tax summary. format: double federalTaxPaidAmount: type: number description: The total amount of federal tax paid for the member's disability tax summary. format: double federalTaxPayableAmount: type: number description: The total amount of federal tax payable for the member's disability tax summary. format: double federalTaxInBatchAmount: type: number description: The total amount of federal tax in batch for the member's disability tax summary. format: double socSecTaxTotalAmount: type: number description: The total Social Security tax amount for the member's disability tax summary. format: double socSecTaxPaidAmount: type: number description: The total amount of Social Security tax paid for the member's disability tax summary. format: double socSecTaxPayableAmount: type: number description: The total amount of Social Security tax payable for the member's disability tax summary. format: double socSecTaxInBatchAmount: type: number description: The total amount of Social Security tax in batch for the member's disability tax summary. format: double medicareTaxTotalAmount: type: number description: The total Medicare tax amount for the member's disability tax summary. format: double medicareTaxPaidAmount: type: number description: The total amount of Medicare tax paid for the member's disability tax summary. format: double medicareTaxPayableAmount: type: number description: The total amount of Medicare tax payable for the member's disability tax summary. format: double medicareTaxInBatchAmount: type: number description: The total amount of Medicare tax in batch for the member's disability tax summary. format: double stateTaxTotalAmount: type: number description: The total state tax amount for the member's disability tax summary. format: double stateTaxPaidAmount: type: number description: The total amount of state tax paid for the member's disability tax summary. format: double stateTaxPayableAmount: type: number description: Represents the amount of state tax payable for a VBA member's disability tax summary. format: double stateTaxInBatchAmount: type: number description: Represents the amount of state tax in batch for a VBA member's disability tax summary. format: double localTaxTotalAmount: type: number description: Represents the total amount of local tax for a VBA member's disability tax summary. format: double localTaxPaidAmount: type: number description: Represents the amount of local tax paid for a VBA member's disability tax summary. format: double localTaxPayableAmount: type: number description: Represents the amount of local tax payable for a VBA member's disability tax summary. format: double localTaxInBatchAmount: type: number description: Represents the amount of local tax in batch for a VBA member's disability tax summary. format: double additionalProperties: false description: This class represents a summary of disability tax information for a VBA member. VBA_MembersDisabilityTaxSummaryVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBA_MembersDisabilityTaxSummary' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_PayorAccountCheckProcessing: required: - account_Key - payor_ID type: object properties: payor_ID: maxLength: 20 minLength: 1 type: string description: Unique identifier assigned to the Payor. account_Key: type: integer description: References the Funding Account's Account Key associated with this Payor/Account. format: int32 payor_Name: maxLength: 100 type: string description: Name of the Payor individual or institution. nullable: true account_Name: maxLength: 64 type: string description: The Funding Account Name nullable: true account_Balance: type: number description: The Payor Account's calculated Account Balance format: double candidate_Balance: type: number description: Calculated balance for all candidate Claims format: double candidate_Count: type: integer description: Number of individual candidate Claims format: int32 signature_Key: type: integer description: The Funding or Payor Account's Signature key. format: int32 selected: type: integer description: Presence indicator for Candidate Balance or Candidate Count format: int32 additionalProperties: false VBA_PayorAccountCheckProcessingVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBA_PayorAccountCheckProcessing' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_PremInvoiceSubscriberDetail: type: object properties: invoice_Key: type: integer description: The key of the invoice associated with this subscriber detail. format: int32 group_ID: type: string description: The group ID of the subscriber. nullable: true division_ID: type: string description: The division ID of the subscriber. nullable: true subscriber_ID: type: string description: The ID of the subscriber. nullable: true premRate_Key: type: integer description: The key of the premium rate associated with this subscriber detail. format: int32 premium: type: number description: The premium amount. format: double total_Premium_Received: type: number description: The total premium received. format: double payee_ID: type: string description: The payee ID. nullable: true rate_Type: type: string description: 'The type of rate (e.g., Member Rate).' nullable: true rate_Display: type: string description: The display of the rate. nullable: true premRateBasis_Description: type: string description: The description of the rate basis. nullable: true premRate_Category: type: string description: The category of the premium rate. nullable: true volume: type: number description: The volume associated with this subscriber detail. format: double dist_Volume: type: number description: The distributed volume. format: double premium_Received_Date: type: string description: The date when premium was received. format: date-time nullable: true premium_Received: type: number description: The premium received amount. format: double payment_Posted: type: number description: The amount of payment posted. format: double payment_Posted_Date: type: string description: The date when payment was posted. format: date-time nullable: true payment_Date: type: string description: The date of payment. format: date-time nullable: true payment_Amount: type: number description: The amount of payment. format: double payment_ID: type: string description: The ID of the payment. nullable: true payment_Name: type: string description: The name of the payment. nullable: true update_Date: type: string description: The date of the last update. format: date-time nullable: true update_User: type: string description: The user who made the last update. nullable: true premInvoiceReceived_Key: type: integer description: The key of the premium invoice received. format: int32 premium_Waived: type: boolean description: Indicates if premium is waived for this subscriber. additionalProperties: false VBA_PremInvoiceSubscriberDetailAdjustment: type: object properties: invoiceAdjustment_Key: type: integer format: int32 nullable: true invoice_Key: type: integer format: int32 nullable: true group_ID: type: string nullable: true division_ID: type: string nullable: true subscriber_ID: type: string nullable: true premRate_Key: type: integer format: int32 nullable: true adjustment_Amount: type: number format: double nullable: true total_Adjustment_Received: type: number format: double nullable: true adjustment_Reason: type: integer format: int32 nullable: true volume: type: number format: double nullable: true entry_Date: type: string format: date-time nullable: true entry_User: type: string nullable: true update_Date: type: string format: date-time nullable: true update_User: type: string nullable: true premRate_Category: type: string nullable: true adjustment_Received_Date: type: string format: date-time nullable: true adjustment_Received: type: number format: double nullable: true payment_Posted: type: number format: double nullable: true payment_Posted_Date: type: string format: date-time nullable: true payment_Date: type: string format: date-time nullable: true payment_Amount: type: number format: double nullable: true payment_ID: type: string nullable: true payment_Name: type: string nullable: true premInvoiceAdjReceived_Key: type: integer format: int32 nullable: true description: type: string nullable: true effective_Date: type: string format: date-time nullable: true additionalProperties: false VBA_PremInvoiceSubscriberDetailAdjustmentListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_PremInvoiceSubscriberDetailAdjustment' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_PremInvoiceSubscriberDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_PremInvoiceSubscriberDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_PremInvoiceSubscriberHistory: type: object properties: adjustment: type: string nullable: true subscriberID: type: string nullable: true invoiceKey: type: integer format: int32 nullable: true premRateID: type: string nullable: true categoryDescription: type: string nullable: true basisDescription: type: string nullable: true planName: type: string nullable: true tier: type: string nullable: true rateType: type: string nullable: true rateTypeDescription: type: string nullable: true rateDescription: type: string nullable: true premium: type: number format: double nullable: true premiumReceived: type: number format: double nullable: true reason: type: string nullable: true additionalProperties: false VBA_PremInvoiceSubscriberHistoryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_PremInvoiceSubscriberHistory' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_ReinsContractTransAmount: type: object properties: reinsContractTrans_Key: type: integer format: int32 reinsContract_Key: type: integer format: int32 description: type: string nullable: true subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true transaction_Type: type: string nullable: true transaction_Status: type: string nullable: true transaction_Claim_Number: type: string nullable: true transaction_Amount: type: number format: double nullable: true transaction_Date: type: string format: date-time nullable: true entry_User: type: string nullable: true entry_Date: type: string format: date-time nullable: true update_User: type: string nullable: true update_Date: type: string format: date-time nullable: true reinsContract_Description: type: string nullable: true member_First_Name: type: string nullable: true member_Last_Name: type: string nullable: true submitted_Date: type: string format: date-time nullable: true specific_Deductible: type: number format: double nullable: true claim_Reimbursed: type: number format: double nullable: true deductible_Reimbursed: type: number format: double nullable: true aggSpec_Deductible_Reimbursed: type: number format: double nullable: true reimburse_Received: type: number format: double nullable: true claim_Not_Covered: type: number format: double nullable: true aggSpec_Deductible_Current: type: number format: double nullable: true initial_ReinsContractTrans_Key: type: integer format: int32 nullable: true laser_Deductible: type: number format: double nullable: true aggSpecMember: type: boolean aggregate_Specific_Deductible: type: number format: double nullable: true additionalProperties: false VBA_ReinsContractTransAmountVBAResponse: type: object properties: data: $ref: '#/components/schemas/VBA_ReinsContractTransAmount' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_ReinsContractTransClaim: type: object properties: reinsContractTrans_Key: type: integer format: int32 claim_Number: type: integer format: int32 nullable: true entry_User: type: string nullable: true entry_Date: type: string format: date-time nullable: true update_User: type: string nullable: true update_Date: type: string format: date-time nullable: true service_Date: type: string format: date-time nullable: true service_Thru: type: string format: date-time nullable: true processed_Date: type: string format: date-time nullable: true check_ID: type: integer format: int32 nullable: true check_Number: type: string nullable: true member_First_Name: type: string nullable: true member_Last_Name: type: string nullable: true provider_Org_Name: type: string nullable: true provider_First_Name: type: string nullable: true provider_Last_Name: type: string nullable: true paidAmount: type: number format: double nullable: true claim_Paid_Amount_On_Trans: type: number format: double nullable: true claimTransaction_Status: type: string nullable: true claimTransaction_Reimbursed: type: number format: double nullable: true specDed_Reimbursed: type: number format: double nullable: true aggSpecDed_Reimbursed: type: number format: double nullable: true claimTransaction_Not_Covered: type: number format: double nullable: true claimPaid: type: boolean additionalProperties: false VBA_ReinsContractTransClaimListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_ReinsContractTransClaim' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_ReinsContractTransReimburse: type: object properties: reinsContractTransReimburse_Key: type: integer format: int32 reinsContractTrans_Key: type: integer format: int32 funding_Key: type: integer format: int32 nullable: true entry_User: type: string nullable: true entry_Date: type: string format: date-time nullable: true update_User: type: string nullable: true update_Date: type: string format: date-time nullable: true issue_ID: type: string nullable: true issue_Date: type: string format: date-time nullable: true issue_Amount: type: number format: double nullable: true additionalProperties: false VBA_ReinsContractTransReimburseListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_ReinsContractTransReimburse' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_ReinsContractTransactionSummary: type: object properties: reinsContractTrans_Key: type: integer format: int32 reinsContract_Key: type: integer format: int32 description: type: string nullable: true subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true transaction_Type: type: string nullable: true transaction_Status: type: string nullable: true transaction_Claim_Number: type: string nullable: true transaction_Amount: type: number format: double nullable: true transaction_Date: type: string format: date-time nullable: true submitted_Date: type: string format: date-time nullable: true first_Name: type: string nullable: true last_Name: type: string nullable: true initial_Transaction: type: boolean additionalProperties: false VBA_ReinsContractTransactionSummaryListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_ReinsContractTransactionSummary' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_Report: type: object properties: reportDefinition_Key: type: integer format: int32 report_ID: type: string nullable: true report_Name: type: string nullable: true report_Category: type: string nullable: true report_Description: type: string nullable: true embed_Url: type: string nullable: true additionalProperties: false VBA_ReportListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VBA_Report' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false VBA_SSOLoginConfig: type: object properties: name: type: string description: Name of the SSO connection client. nullable: true description: type: string description: Description of this SSO connection. nullable: true login_URL: type: string description: The URL used to login to the client's SSO instance nullable: true additionalProperties: false VerifyMFADeviceSetupRequest: type: object properties: friendlyDeviceName: type: string description: The friendly device name. nullable: true accessToken: type: string description: The session that should be passed both ways in challenge-response calls to the service. nullable: true userCode: type: string description: The one-time password computed using the secret code returned by AssociateSoftwareToken. nullable: true additionalProperties: false VerifyMFADeviceSetupResponse: type: object properties: status: type: string description: The status of the verified MFA Device. nullable: true additionalProperties: false VerifyMFADeviceSetupResponseVBAResponse: type: object properties: data: $ref: '#/components/schemas/VerifyMFADeviceSetupResponse' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false Volume: type: object properties: groupVolume_Key: type: integer format: int32 volume_Description: type: string nullable: true effective_Rate: type: integer format: int32 additionalProperties: false Workflow: required: - disabled - workflow_Key type: object properties: workflow_Key: type: integer description: 'Identifier of the workflow. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 criteria_Key: type: integer description: Identifies the criteria associated with the workflow. format: int32 nullable: true criteria_SQL: type: string description: The SQL used to determine which claims fall under this workflow nullable: true description: maxLength: 512 type: string description: Description of the workflow. nullable: true disabled: type: boolean description: 'Disables the selected workflow. Note: This field is marked as NOT NULL in the database and therefore required by the API.' entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true last_Execute_Date: type: string description: Last time this Workflow was checked format: date-time nullable: true prerequisite_Workflow_Key: type: integer description: Identifies the workflow step that preceeds the selected step. format: int32 nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true workflow_Type: maxLength: 32 type: string description: Identifies the service area associated with the workflow. nullable: true additionalProperties: false WorkflowAuth: type: object properties: workflow_Key: type: integer format: int32 nullable: true workflowTask_Key: type: integer format: int32 nullable: true auth_Number: type: string nullable: true user_ID: type: string nullable: true assign_User_ID: type: string nullable: true additionalProperties: false WorkflowCheck: type: object properties: workflow_Key: type: integer format: int32 nullable: true workflowTask_Key: type: integer format: int32 nullable: true check_ID: type: integer format: int32 nullable: true user_ID: type: string nullable: true assign_User_ID: type: string nullable: true additionalProperties: false WorkflowClaim: type: object properties: workflow_Key: type: integer format: int32 nullable: true workflowTask_Key: type: integer format: int32 nullable: true batch_Number: type: integer format: int32 batch_Claim: type: integer format: int32 user_ID: type: string nullable: true assign_User_ID: type: string nullable: true additionalProperties: false WorkflowDetail: required: - workflowDetail_Key type: object properties: workflowDetail_Key: type: integer description: 'Unique identifier for the workflow table. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 assign_Date: type: string description: Date when the workflow item was assigned. format: date-time nullable: true assign_Message: type: string description: Message that was given to the assignment. nullable: true assign_User_ID: maxLength: 20 type: string description: ID of the User who assigned the workflow item. nullable: true complete_Date: type: string description: Date when the workflow item was completed. format: date-time nullable: true complete_Message: type: string description: Message that was given to the completion. nullable: true complete_User_ID: maxLength: 20 type: string description: ID of the User who completed the workflow item. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true event_ID: type: integer description: No longer in use format: int32 nullable: true key_Column1: maxLength: 128 type: string description: Defines the subject of 'Key_Value1'. nullable: true key_Column2: maxLength: 128 type: string description: Defines the subject of 'Key_Value2'. nullable: true key_Column3: maxLength: 128 type: string description: Defines the subject of 'Key_Value3'. nullable: true key_Column4: maxLength: 128 type: string description: Defines the subject of 'Key_Value4'. nullable: true key_Column5: maxLength: 128 type: string description: Defines the subject of 'Key_Value5'. nullable: true key_DataType1: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value1'. nullable: true key_DataType2: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value2'. nullable: true key_DataType3: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value3'. nullable: true key_DataType4: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value4'. nullable: true key_DataType5: maxLength: 32 type: string description: Identifies the type of data of the value specified by 'Key_Value5'. nullable: true key_Value1: maxLength: 128 type: string description: Value of the subject specified by 'Key_Column1'. nullable: true key_Value2: maxLength: 128 type: string description: Value of the subject specified by 'Key_Column2'. nullable: true key_Value3: maxLength: 128 type: string description: Value of the subject specified by 'Key_Column3'. nullable: true key_Value4: maxLength: 128 type: string description: Value of the subject specified by 'Key_Column4'. nullable: true key_Value5: maxLength: 128 type: string description: Value of the subject specified by 'Key_Column5'. nullable: true process_Date: type: string description: Date when the workflow item was processed. format: date-time nullable: true process_Message: type: string description: Message that was given to the process. nullable: true process_User_ID: maxLength: 20 type: string description: ID of the User who processed the workflow item. nullable: true reject_Date: type: string description: Date when the workflow item was rejected. format: date-time nullable: true reject_Message: type: string description: Message that was given to the rejection. nullable: true reject_User_ID: maxLength: 20 type: string description: ID of the User who rejected the workflow item. nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true user_ID: maxLength: 20 type: string description: ID of the User whom the workflow detail was assigned to. nullable: true workflowTask_Seq: type: integer description: Sequential identifier for the workflow table. format: int32 nullable: true workflow_Key: type: integer description: Identifier of the workflow. format: int32 nullable: true workflow_Type: maxLength: 32 type: string description: Type of the associated workflow. nullable: true additionalProperties: false WorkflowDetailListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/WorkflowDetail' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowDetailVBAResponse: type: object properties: data: $ref: '#/components/schemas/WorkflowDetail' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowEnrollment: type: object properties: workflow_Key: type: integer format: int32 nullable: true workflowTask_Key: type: integer format: int32 nullable: true subscriber_ID: type: string nullable: true member_Seq: type: string nullable: true user_ID: type: string nullable: true assign_User_ID: type: string nullable: true additionalProperties: false WorkflowListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Workflow' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowProcessing: type: object properties: current_User_ID: type: string nullable: true assign_User_ID: type: string nullable: true message: type: string nullable: true workflowClaims: type: array items: $ref: '#/components/schemas/WorkflowClaim' nullable: true workflowAuths: type: array items: $ref: '#/components/schemas/WorkflowAuth' nullable: true workflowChecks: type: array items: $ref: '#/components/schemas/WorkflowCheck' nullable: true workflowEnrollments: type: array items: $ref: '#/components/schemas/WorkflowEnrollment' nullable: true additionalProperties: false WorkflowTask: required: - workflow_Key - workflowTask_Seq type: object properties: workflow_Key: type: integer description: 'Identifier of the workflow. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 workflowTask_Seq: type: integer description: 'Identifies the order of the associated task. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 description: maxLength: 512 type: string description: Description of the associated task. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false WorkflowTaskListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/WorkflowTask' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowTaskOption: required: - workflow_Key - workflowTask_Option - workflowTask_Seq type: object properties: workflow_Key: type: integer description: Identifier of the workflow. format: int32 workflowTask_Seq: type: integer description: Identifies the order of the associated task. format: int32 workflowTask_Option: maxLength: 32 minLength: 1 type: string description: Identifies the option to be used by the selected workflow task. These options will be specific to the workflow's 'Type'. additionalProperties: false WorkflowTaskOptionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/WorkflowTaskOption' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowTaskOptionVBAResponse: type: object properties: data: $ref: '#/components/schemas/WorkflowTaskOption' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowTaskUser: required: - set_Complete - set_Process - set_Reject - user_ID - workflow_Key - workflowTask_Seq type: object properties: workflow_Key: type: integer description: 'Identifier of the workflow. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 workflowTask_Seq: type: integer description: 'Identifies the order of the associated task. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 user_ID: maxLength: 20 minLength: 1 type: string description: ID of the User who is assigned to the selected 'Workflow Task'. entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true set_Complete: type: boolean description: 'Allows the associated User to set workflow items to ''Complete''. Note: This field is marked as NOT NULL in the database and therefore required by the API.' set_Process: type: boolean description: 'Allows the associated User to set workflow items to ''Process''. Note: This field is marked as NOT NULL in the database and therefore required by the API.' set_Reject: type: boolean description: 'Allows the associated User to set workflow items to ''Reject''. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false WorkflowTaskUserListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/WorkflowTaskUser' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowTaskUserVBAResponse: type: object properties: data: $ref: '#/components/schemas/WorkflowTaskUser' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowTaskVBAResponse: type: object properties: data: $ref: '#/components/schemas/WorkflowTask' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowType: required: - workflow_Type type: object properties: workflow_Type: maxLength: 32 minLength: 1 type: string description: Name of the workflow type. description: maxLength: 512 type: string description: Description of the workflow type. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true workflow_Criteria_DataObject: maxLength: 128 type: string description: Data object that the workflow type must point to. nullable: true additionalProperties: false WorkflowTypeListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/WorkflowType' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowTypeTaskOption: required: - system_Process_Option - workflow_Type - workflowTask_Option type: object properties: workflow_Type: maxLength: 32 minLength: 1 type: string description: Identifies the workflow type that options are displayed for. workflowTask_Option: maxLength: 32 minLength: 1 type: string description: Identifies the available task option for the identified workflow type. description: maxLength: 512 type: string description: Description of the task option. nullable: true display: maxLength: 256 type: string description: Name of the task option. nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true system_Process_Option: type: boolean description: 'If this option is set to 1, the system will automatically process claims assigned to this workflow task. Note: This field is marked as NOT NULL in the database and therefore required by the API.' update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false WorkflowTypeTaskOptionListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/WorkflowTypeTaskOption' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowTypeTaskOptionVBAResponse: type: object properties: data: $ref: '#/components/schemas/WorkflowTypeTaskOption' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowTypeVBAResponse: type: object properties: data: $ref: '#/components/schemas/WorkflowType' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowUser: required: - user_ID - workflow_Key type: object properties: workflow_Key: type: integer description: 'Identifier of the workflow. Note: This field is marked as NOT NULL in the database and therefore required by the API.' format: int32 user_ID: maxLength: 20 minLength: 1 type: string description: ID of the User who is assigned to the workflow. entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false WorkflowUserListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/WorkflowUser' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowUserVBAResponse: type: object properties: data: $ref: '#/components/schemas/WorkflowUser' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false WorkflowVBAResponse: type: object properties: data: $ref: '#/components/schemas/Workflow' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ZipCodes: required: - zip_Code type: object properties: zip_Code: maxLength: 32 minLength: 1 type: string description: Zip Code as specified by the US Postal Service city: maxLength: 64 type: string description: City where the Zip Code is located nullable: true country_ID: maxLength: 8 type: string description: Country ID as specified by the US Postal Service nullable: true county: maxLength: 64 type: string description: County where the Zip Code is located nullable: true entry_Date: type: string description: Date record was first added to the system format: date-time entry_User: maxLength: 20 type: string description: User that first added the record to the system nullable: true state: maxLength: 2 type: string description: State where the Zip Code is located nullable: true update_Date: type: string description: Date the record was last updated in the system format: date-time update_User: maxLength: 20 type: string description: User that last updated the record in the system nullable: true additionalProperties: false ZipCodesListVBAResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ZipCodes' nullable: true error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false ZipCodesVBAResponse: type: object properties: data: $ref: '#/components/schemas/ZipCodes' error: $ref: '#/components/schemas/VBAProblemDetails' debug: $ref: '#/components/schemas/Debug' additionalProperties: false securitySchemes: apiKeyAuth: type: apiKey description: Input apikey to access this API name: x-api-key in: header bearerAuth: type: http description: Input bearer token to access this API scheme: bearer bearerFormat: JWT basicAuth: type: http description: Input your username and password to access this API scheme: basic security: - apiKeyAuth: [ ] bearerAuth: [ ] basicAuth: [ ] x-tagGroups: - name: Accounting tags: - Accounting - Check Batches - Check Details - Check Edit Details - Check Edit Headers - Check Edits - Check Statuses - Check Types - Checks - Funding - Funding Account - Funding Account Category - Funding Account Signatures - Funding Account Type - Funding Deposits - Funding Indicators - Funding Issue Types - Funding Reconciliation Disbursements - Funding Reconciliation On Statements - Funding Reconciliation Statuses - Funding Reconciliations - Funding Reconciliations Received - Funding References - Funding Request Claims - Funding Request Statuses - Funding Request Types - Funding Requests - Funding Statement Formats - Funding Statuses - Funding Types - Payor Account Notifications - Payor Account Signatures - Payor Accounts - PremInvoiceList - Signatures - name: Admin tags: - Change Data Capture - Client Config - Company Data - EDI Code Mappings - Feedback - IPWhitelists - Job Execution Metadata - Job Executions - Job Types - Jobs - VBAInterface ID Codes - VBAInterface Map Types - VBAInterface Statuses - VBAInterface Types - VBAInterface Vendors - VBAInterfaces - name: Advanced APIs tags: - Adv. Accounting - Adv. Auth - Adv. Benefits - Adv. Billing - Adv. Capitation - Adv. Claim - Adv. Commission - Adv. Enrollment - Adv. FeeSchedule - Adv. Grievance - Adv. Group Contracts - Adv. Group Divisions - Adv. Groups - Adv. Reinsurance - Adv. Workflow - name: Auth tags: - Auth - Auth Action - Auth Code - Auth Diagnostic Codes - Auth Max Calc - Auth Procedure Codes - Auth Reference - Auth Review - Auth Review Level - Auth Review Severity - Auth Review Status - Auth Review Type - Auth Review Urgency Type - Auth Type Places - Auth Types - name: Benefit tags: - Benefit Categories - Benefit Diagnostic Codes - Benefit Places - Benefit Procedures - Benefit Provider Types - Benefit Specialties - Benefits - Disability Event Case Changes - Disability Event Deduction Changes - Disability Event Field Changes - Disability Event Fields - Disability Event Groups - Issue Duration Values - Plan Accumulator Benefits - Plan Accumulators - Plan Auth Penalties - Plan Auth Penalty Benefits - Plan Benefit Cascades - Plan Benefit Clusters - Plan Benefit Diagnosis Ex Codes - Plan Benefit Diagnostic Codes - Plan Benefit Levels - Plan Benefit Maximums - Plan Benefit Modifier Ex Codes - Plan Benefit PBM Co-Pays - Plan Benefit Place Authorizations - Plan Benefit Place Co-Insurance - Plan Benefit Place Co-Pays - Plan Benefit Place Ex Codes - Plan Benefit Places - Plan Benefit Procedure Ex Codes - Plan Benefit Procedure Maximums - Plan Benefit Procedures - Plan Benefit Provider Types - Plan Benefit Rates - Plan Benefit Specialties - Plan Benefit Tooth Maximums - Plan Benefits - Plan Diagnosis Age Restrictions - Plan Disability Limits - Plan Display Types - Plan Displays - Plan Lineage Details - Plan Lineages - Plan Maximums - Plan Modifiers - Plan Pre-existing Coverages - Plan Procedure Age Restriction Modifiers - Plan Procedure Age Restrictions - Plan Relationship Age Restrictions - Plan Types - Plans - Report Static Lists - name: Billing tags: - Billing - Billing Basis - Group Bill Cycle Payment Methods - Invoice Reasons - Payment Methods - Prem Rate Types - Premium Distributions - Premium Invoice Adjustments - Premium Invoice Adjustments Received - Premium Invoice Payments - Premium Invoice Subscriber Details - Premium Invoice Subscribers - Premium Invoices - Premium Invoices Received - Premium Invoices Self-Admin - Premium Invoices Self-Admin Received - Premium Past Due Group Triggers - Premium Past Due Subscriber Triggers - Premium Past Due Triggers - Premium Payment File Formats - Premium Payment Types - Premium Payments - Premium Payments On Accounts - Premium Payments on Subscribers - Premium Rate Add-Ons - Premium Rate Age Types - Premium Rate Basis - Premium Rate Categories - Premium Rate Distribution Types - Premium Rate Excludes - Premium Rate Members - Premium Rate Min/Max - Premium Rate Min/Max Details - Premium Rate Pace Types - Premium Rate Paces - Premium Rate Payees - Premium Rate Zipcodes - Premium Rates - name: CallTracking tags: - Call Destinations - Call Statuses - Call Tracking Subscribers - Call Trackings - Call Types - Caller Types - CallTrackingDiagCodes - CallTrackingProcCodes - name: Capitation tags: - Capitation Adjustment Reasons - Capitation Adjustment Types - Capitation Adjustments - Capitation Categories - Capitation Category Types - Capitation Plan Rates - Capitation Service Plans - Capitation Service Tax IDs - Capitation Services - Capitation Transactions - Capitation Types - Capitations - name: CareManagement tags: - Care Case Actions - Care Case Authorizations - Care Case Clinical Fact Categories - Care Case Clinical Fact Category Types - Care Case Clinical Facts - Care Case Clinical Trial Arms - Care Case Clinical Trial Reasons - Care Case Clinical Trial Study Phases - Care Case Clinical Trials - Care Case Compliances - Care Case Concordances - Care Case Details - Care Case Diagnoses - Care Case Eligibility Statuses - Care Case Emetic Risks - Care Case Intake Secondary Types - Care Case Intake Types - Care Case Intakes - Care Case Intents - Care Case Log Entry Types - Care Case Lots - Care Case Medications - Care Case Members - Care Case Neutropenic Risks - Care Case Providers - Care Case Savings - Care Case Savings Secondary Types - Care Case Savings Types - Care Case Stages - Care Case Treatment Types - Care Case Treatments - Care Case Work Log Savings Types - Care Case Work Log Secondary Log Types - Care Case Work Log Types - Care Case Work Logs - Care Cases - Care Manager Care Plans - Care Manager Care Types - Care Manager Cases - Care Manager Mappings - Care Manager Types - Care Managers - Care Plan Categories - Care Plan Custom Values - Care Plan Details - Care Plan Rule Criterias - Care Plan Rule Details - Care Plan Rules - Care Plan Score Details - Care Plan Scores - Care Plans - Care Types - Care Unit Managers - Care Units - Case Attachment Types - Case Attachments - Case Close Reasons - Case Head Types - Case Heads - Case Medical Concordance Levels - Case Priorities - Case Reasons - Case Status Reasons - Case Statuses - name: Chat tags: - VBAssist - name: Claim tags: - Auth Actions - Claim Adjudication - Claim Anesthesia Modifier Units - Claim Anesthesia Place Code Units - Claim Anesthesia Procedure Code Units - Claim Audit Appeal Reasons - Claim Audit Appeal Results - Claim Audit Clauses - Claim Audit Detail Results - Claim Audit Details - Claim Audit Results - Claim Audit Statuses - Claim Audits - Claim Batch - Claim Batch Detail Benefits - Claim Batch Details - Claim Batch Life Benefits - Claim Batch Logs - Claim Batch Plans - Claim Batch References - Claim Batch Types - Claim Batches - Claim Batches Statuses - Claim Coding Rule Types - Claim Coding Rules - Claim Condition Codes - Claim Custom Ex Code Rules - Claim Deduction Types - Claim Detail Deductions - Claim Detail Ex Codes - Claim Details - Claim Disabilities - Claim Disability Deductions - Claim Ex Codes - Claim Funded Statuses - Claim Invoice - Claim Invoice Adjustment Reasons - Claim Invoice Adjustment Received - Claim Invoice Adjustments - Claim Invoice Details - Claim Invoice Payments - Claim Invoice Received - Claim Lives - Claim Occurrence Codes - Claim Payments - Claim PreBatch Details - Claim PreBatches - Claim Prompt Pays - Claim Queue Details - Claim Queue Logs - Claim Queue Notify User Groups - Claim Queue Notify Users - Claim Queue Priorities - Claim Queue Process Tracking - Claim Queue Processors - Claim Queue Results - Claim Queue Schedule Notify User Groups - Claim Queue Schedule Notify Users - Claim Queue Schedules - Claim Queue Statuses - Claim Queues - Claim Reprice Remove - Claim Rule Dependents - Claim Rule Procedures - Claim Rule Provider Types - Claim Rule Set Details - Claim Rule Set Headers - Claim Rule Types - Claim Rules - Claim Statuses - Claim Transactions - Claim Value Codes - Claims - Duplicate Columns - Duplicate Master Sets - Duplicate Masters - Duplicate Set Columns - Duplicate Sets - EDICustomFields - EDICustomFieldValueClaims - Error Category - Error Category Types - Error Severity - Error Type - Events - Flex Claim Details - Flex Claim Services - Flex Claims - Premium Claim - Reviewed Status - Suspense Claims - Suspense Criterias - Suspense Types - name: Commission tags: - Commission Activity - Commission Activity Parameters - Commission Adjustment Reasons - Commission Adjustment Types - Commission Adjustments - Commission Agencies - Commission Agency Rep Rates - Commission Agency Reps - Commission Agency Types - Commission Appointment Types - Commission Basis - Commission Categories - Commission Cycles - Commission License Types - Commission Rate Cluster Agency Rep - Commission Rate Cluster Rates - Commission Rate Clusters - Commission Rate Subscribers - Commission Rates - Commission Rep Accounts - Commission Rep Appointments - Commission Rep Groups - Commission Rep Licenses - Commission Rep Subscribers - Commission Rep Types - Commission Reps - Commission Transactions - Commissions - Unassigned Commission Adjustments - name: Common tags: - Admission Type Places - Age Settings - Agriculture Tax Returns - Amount Details - APC Codes - APC Weights - Armor Code ExCode - Bill Type Places - Bill Types - Billing Cycles - Brokerage - Claim Queue Types - Claim Types - CLIA Certificate - CLIA Certificate Procedure Codes - COB Types - College Types - Colleges - Communication Methods - Contact Assignments - Contact Categories - Contact Emails - Contact Mappings - Contact Phone - Contact Statuses - Contacts - Context4 Lists - Context4Health Cost Containment CaseIndex - Context4Health Cost Containment Category - Context4Health Cost Containment Default Action - Context4Health Cost Containment Errors - Context4Health Cost Containment Ex Codes - Context4Health Cost Containment Message Types - Context4Health Cost Containment Option Pricing - Context4Health Cost Containment Options - Cost Contain Zelis ExCodes - Country - Country Dialing Codes - County - Coverage Types - Criteria - Criteria Columns - Currency - Data Types - Day Intervals - Diagnostic Code Groups - Diagnostic Code Types - Diagnostic Codes - Disability Options - Disaster Locations - Disasters - DRG Cluster - DRG Cluster Detail - DRG Codes - DRG Schedule - DRG Weight - Drug Code Units - Drug Codes - Eligibility Status - Employer Contribution Schedule Types - Employer Sizes - Ethnicity Codes - Event Priority Levels - Event Status Types - Ex Code Result Types - Expense Types - Explaination Code Categories - Explanation Codes - External ID - Filter Types - Filters - Flex Types - Forfeiture Statuses - Frequency Intervals - Gender - Group Codes - HIPAA Adjustment Codes - HIPAA Benefit Codes - HIPAA Claim Status Category Codes - HIPAA Claim Status Codes - HIPAA Plan Types - HIPAA Reasons - HIPAA Relationships - HIPAA Tiers - ID Code Types - ID Code Values - ID Types - Insurance Carrier Types - Insurance Carriers - Insurance Priorities - Insurance Types - Interface Types - Invoice Status - Invoice Types - Language Skill Levels - Languages - Life Options - Local Taxes - Logging - LogType - Marital Statuses - Modifiers - Network Modifiers - Network Practice Types - Network Procedure Clusters - Network Profile Assignments - Network Profile Networks - Network Profiles - Network Types - Networks - Objects - Occupations - Pay Frequency - Payee Accounts - Payees - Payor - Payor Filters - Payor Reports - PBM Types - Places of Service - Policy Forfeiture Ext - Policy Forfeiture Ext Details - Policy Statuses - Procedure Categories - Procedure Cluster Details - Procedure Clusters - Procedure Code Qualifiers - Procedure Code Sets - Procedure Codes - Procedure Groups - Process Logging - Process Parameters - Processes - Provider Types - Reasons - Relationships - Rounding Precision - Rounding Types - Search Config - Search Criteria - Search Operators - Search Request - Send To - Sex Codes - Specialty - State Interest - State Procedure Code Taxes - States - Suffix - Tax Filing Status - Taxonomy - Taxonomy Group Details - Taxonomy Group Types - Taxonomy Groups - Tiers - Timely Filing - Tooth - Tooth Actions - Tooth Chart Types - Tooth Charts - Tooth Procedures - Tooth Quadrants - Transplant Types - Treatment Types - UC Network - Unit Type Conversions - Unit Types - VBA Plan Types - Volume Types - Yes No List - Zelis Cost Containment Claim Detail Repricing - Zelis Cost Containment Claim Repricing - Zelis Cost Containment Edit Codes - Zelis Cost Containment EOB Codes - Zelis Cost Containment Polls - ZipCodes - name: Controllers tags: - Client Config - name: Credentialing tags: - Credentialing Amounts - Credentialing Attestation Methods - Credentialing Attestation Questions - Credentialing Attestation Sources - Credentialing Attestation Types - Credentialing Carriers - Credentialing Certifications - Credentialing Confidentials - Credentialing Contracts - Credentialing Dates - Credentialing Education Types - Credentialing License Types - Credentialing Options - Credentialing Practice Categories - Credentialing Practice Category Types - Credentialing Quality - Credentialing Services - Credentialing Statuses - Credentialing Techniques - Credentialing Terminations - Credentialing Types - Provider Credentialing - Provider Credentialing Amounts - Provider Credentialing Attestations - Provider Credentialing Certifications - Provider Credentialing Confidentials - Provider Credentialing Contracts - Provider Credentialing Counties - Provider Credentialing Dates - Provider Credentialing Education - Provider Credentialing Hours - Provider Credentialing Hyperlinks - Provider Credentialing Licenses - Provider Credentialing Malpractice - Provider Credentialing Options - Provider Credentialing Practice Offices - Provider Credentialing Practices - Provider Credentialing Quality - Provider Credentialing Services - Provider Credentialing Techniques - Provider Credentialing Terminations - name: Enrollment tags: - Enrollment Accumulators - Enrollment Waiting Period Subscribers - Enrollment Waiting Periods - Member Account Plan Payments - Member Account Plans - Member Accounts - Member Accum - Member Address - Member Address History - Member Beneficiary - Member Beneficiary Plans - Member Care Alerts - Member Case Heads - Member Classes - Member COB Savings - Member Colleges - Member Eligibility Status - Member Enrollment Plan Rider - Member Enrollment Plans - Member ID Card Request Types - Member ID Card Requests - Member ID Cards Printed - Member Insurance - Member Languages - Member Medicare Reponsibility - Member Networks - Member Occupations - Member Payments - Member Plan Years - Member Pre-existing Diagnostic Codes - Member PreEx Disclosed Diags - Member Prior Accumulators - Member Provider Alternates - Member Providers - Member Taxes - Member Tooth - Member Tooth Ex Codes - Member VBA Plan Type IDs - Members - Subscriber Accumulators - Subscriber Enrollment Plan Riders - Subscriber Enrollment Plans - Subscriber Enrollments - Subscriber Flex - Subscriber Flex Exports - Subscriber Flex Payments - Subscriber ID Code History - Subscriber ID Codes - Subscriber Payment Methods - Subscriber Plan Policies - Subscriber Plan Policy Forfeitures - Subscriber Plan Policy Statuses - Subscriber Premium Rate Splits - Subscriber Prior Accumulators - Subscriber Sponsors - Subscriber Waive Premiums - Subscriber Writing Agents - Subscribers - Waiting Period Types - name: Event tags: - Event Args - Event Schedules - Events - name: FeeSchedule tags: - Fee Schedule Anesthesias - Fee Schedule Details - Fee Schedule Effective Dates - Fee Schedule Modifier Discounts - Fee Schedule Modifier Excludes - Fee Schedule Procedure Group Adjustments - Fee Schedule Provider Type Discounts - Fee Schedules - name: Grievance tags: - Grievance Admin Change Types - Grievance Categories - Grievance Issue Types - Grievance Resolution Types - Grievance Statuses - Grievance Types - Grievances - name: Group tags: - Classes - Contribution Schedules - Flex Issuance Types - Flex Vendor Card Status - Flex Vendor Purse Status - Flex Vendors - Group Account Periods - Group Account Reports - Group ACH Pulls - Group Advice to Pay - Group Calculate Interest Network Options - Group Calculate Interest Options - Group Classes - Group Company Data Ex-Code Overrides - Group Contract Network Types - Group Contract Plan Premiums - Group Contract Plan Rider External IDs - Group Contract Plan Riders - Group Contract Plans - Group Contract Tiers - Group Contracts - Group Coverage Calculations - Group Disenroll Affected Claims - Group Division Captives - Group Division Cobras - Group Division Deduction Types - Group Division ID Codes - Group Divisions - Group End Coverage Age Types - Group Ex-Code Criterias - Group Flex Auto-Create - Group Flex Schedules - Group Flexes - Group IRS 1094C - Group IRS 1095B - Group Multiplier Options - Group Network Add-Ons - Group Network Criteria Columns - Group Network Criterias - Group Networks - Group Participation Incentives - Group Pay Through Day Options - Group Payor Account Benefits - Group Payor Account Networks - Group Payor Account Pay To - Group Payor Account Plan Types - Group Payor Account Provider Federal IDs - Group Payor Account Senders - Group Payor Account Settings - Group Plan Prior Accum Auto Generators - Group Plan Years - Group Premium Rate Categories - Group Price Adjustments - Group Self Admin Settings - Group Start Date Rules - Group Student Age Settings - Group Subscriber Reimbursements - Group Tax Day Limit Types - Group Term Rules - Group UC Percent Claim Types - Group UC Percent Criterias - Group UC Percent Settings - Group VBA Plan Types - Group Volumes - Groups - ID Card Record Statuses - ID Card Request Statuses - Invoice Levels - Payment Schedules - Reimburse Schedules - Tolerances - name: Note tags: - Note Attachments - Note Categories - Note Category Types - Note Data - Note Priorities - Note References - Note Sources - Note Types - name: ProcessAutomation tags: - Process Automation - name: Provider tags: - ' Provider CLIA Certificates' - APC Schedules - Provider - Provider Account - Provider Affiliation - Provider Alternate - Provider APC - Provider Auth Exempt Procedures - Provider Benefit Admin Fees - Provider DRG - Provider Languages - Provider Network - Provider Network Modifier - Provider Payees - Provider Per Diem - Provider Per Diem Procedure - Provider Practice Types - Provider Profile - Provider Rate Adjustments - Provider Rate Column - Provider Rate Criteria - Provider Rate Types - Provider Rates - Provider Roles - Provider Specialty - Provider Suffix - Provider Taxonomy - Provider Withholds - name: Reinsurance tags: - Reinsurance Accumulators - Reinsurance Aggregating Specific Members - Reinsurance Conditional Specific - Reinsurance Conditional Specific Detail - Reinsurance Contract Criteria Details - Reinsurance Contract Criterias - Reinsurance Contract Cycles - Reinsurance Contract Factor Criterias - Reinsurance Contract Factors - Reinsurance Contract Levels - Reinsurance Contract Status - Reinsurance Contract Templates - Reinsurance Contract Transaction Claim Details - Reinsurance Contract Transaction Claim Statuses - Reinsurance Contract Transaction Claims - Reinsurance Contract Transaction Reimbursements - Reinsurance Contract Transaction Statuses - Reinsurance Contract Transactions - Reinsurance Contract Types - Reinsurance Contracts - Reinsurance Domestic Claims Criteria - Reinsurance Member Specific Deductibles - Reinsurance Notify User Groups - Reinsurance Notify Users - Reinsurance Options - name: Report tags: - Report Categories - Report Definitions - Report Queue Detail Arguments - Report Queue Details - Report Queue Logs - Report Queue Schedules - Report Queues - Report Series - Report Series Process Arguments - Report Series Process Templates - Report Series Processes - Report Series Step Args - Report Series Steps - Report Series Tracking Args - Report Tracking - Report Tracking Priorities - Report Tracking Received Statuses - Report Tracking Sent Statuses - Report Tracking Sent To - Report Tracking Statuses - VBA Reports - name: Security tags: - Security Area Objects - Security Area Overrides - Security Area Reports - Security Area User Groups - Security Area Users - Security Areas - Security Field Set Details - Security Field Sets - Security Field User Groups - Security Field Users - Security Fields - Security Group Division User Groups - Security Group Division Users - Security Levels - Security User Limit Member Claim Data - Security User Restrictions - User Field Security - name: Support tags: - Support - name: User tags: - Multi-Factor Auth - User - User Account - User Amount - User Amount Procedure - User Experience - User Group Mappings - User Groups - User LogTypes - User Note Access - UserAmount - VBAGateway Subscription - VBAGateway Subscription Detail - name: Workflow tags: - Workflow Details - Workflow Task Options - Workflow Task Users - Workflow Tasks - Workflow Type Task Options - Workflow Types - Workflow Users - Workflows